list(ListBudgetPoliciesRequest request) {
});
}
- /** Updates a policy */
+ /**
+ * Updates a usage policy. Changes apply only to serverless usage that starts after the update,
+ * not to workloads that are already running.
+ */
public BudgetPolicy update(UpdateBudgetPolicyRequest request) {
return impl.update(request);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicyService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicyService.java
index 2fb7b4b81..864835de2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicyService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/BudgetPolicyService.java
@@ -12,20 +12,24 @@
*/
@Generated
public interface BudgetPolicyService {
- /** Creates a new policy. */
+ /** Creates a new usage policy. The creator is granted the manager role on the new policy. */
BudgetPolicy create(CreateBudgetPolicyRequest createBudgetPolicyRequest);
- /** Deletes a policy */
+ /** Deletes a usage policy. */
void delete(DeleteBudgetPolicyRequest deleteBudgetPolicyRequest);
- /** Retrieves a policy by it's ID. */
+ /** Retrieves a usage policy by its ID. */
BudgetPolicy get(GetBudgetPolicyRequest getBudgetPolicyRequest);
/**
- * Lists all policies. Policies are returned in the alphabetically ascending order of their names.
+ * Lists the usage policies that the caller has permission to view. Policies are sorted by name in
+ * ascending order unless `sort_spec` requests a different order.
*/
ListBudgetPoliciesResponse list(ListBudgetPoliciesRequest listBudgetPoliciesRequest);
- /** Updates a policy */
+ /**
+ * Updates a usage policy. Changes apply only to serverless usage that starts after the update,
+ * not to workloads that are already running.
+ */
BudgetPolicy update(UpdateBudgetPolicyRequest updateBudgetPolicyRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java
index 2ed87cd0e..84c5f62a6 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/CreateBudgetPolicyRequest.java
@@ -11,9 +11,9 @@
@Generated
public class CreateBudgetPolicyRequest {
/**
- * The policy to create. `policy_id` needs to be empty as it will be generated `policy_name` must
- * be provided, custom_tags may need to be provided depending on the cloud provider. All other
- * fields are optional.
+ * The policy to create. `policy_name` must be provided, and `custom_tags` may be required
+ * depending on the cloud provider. Leave `policy_id` empty because Databricks generates it. All
+ * other fields are optional.
*/
@JsonProperty("policy")
private BudgetPolicy policy;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/Filter.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/Filter.java
index e70414cdf..6455bf431 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/Filter.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/Filter.java
@@ -14,9 +14,7 @@
*/
@Generated
public class Filter {
- /**
- * The policy creator user id to be filtered on. If unspecified, all policies will be returned.
- */
+ /** Deprecated: This field is ignored. Creator filtering will be removed in a future version. */
@JsonProperty("creator_user_id")
@QueryParam("creator_user_id")
private Long creatorUserId;
@@ -31,7 +29,8 @@ public class Filter {
private String creatorUserName;
/**
- * The partial name of policies to be filtered on. If unspecified, all policies will be returned.
+ * Only policies whose name contains this string are returned. Matching is case-insensitive. If
+ * unspecified, all policies are returned.
*/
@JsonProperty("policy_name")
@QueryParam("policy_name")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesRequest.java
index 8871004fb..e207ac872 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/ListBudgetPoliciesRequest.java
@@ -24,17 +24,20 @@ public class ListBudgetPoliciesRequest {
private Long pageSize;
/**
- * A page token, received from a previous `ListServerlessPolicies` call. Provide this to retrieve
- * the subsequent page. If unspecified, the first page will be returned.
+ * A page token, received from a previous `ListBudgetPolicies` call. Provide this to retrieve the
+ * subsequent page. If unspecified, the first page will be returned.
*
- * When paginating, all other parameters provided to `ListServerlessPoliciesRequest` must match
- * the call that provided the page token.
+ *
When paginating, all other parameters provided to `ListBudgetPolicies` must match the call
+ * that provided the page token.
*/
@JsonIgnore
@QueryParam("page_token")
private String pageToken;
- /** The sort specification. */
+ /**
+ * How to sort the returned policies. If unspecified, policies are sorted by name in ascending
+ * order.
+ */
@JsonIgnore
@QueryParam("sort_spec")
private SortSpec sortSpec;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/SortSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/SortSpec.java
index a0e3d2442..0ec94544c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/SortSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/SortSpec.java
@@ -15,7 +15,7 @@ public class SortSpec {
@QueryParam("descending")
private Boolean descending;
- /** The filed to sort by */
+ /** The field to sort by. If unspecified, policies are sorted by name. */
@JsonProperty("field")
@QueryParam("field")
private SortSpecField field;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java
index baafb73c5..057e7d8f5 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetPolicyRequest.java
@@ -11,7 +11,7 @@
@Generated
public class UpdateBudgetPolicyRequest {
- /** DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy */
+ /** Deprecated: This field is ignored. */
@JsonIgnore
@QueryParam("limit_config")
private LimitConfig limitConfig;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnInfo.java
index bb8ced06f..6c98860c4 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ColumnInfo.java
@@ -13,7 +13,11 @@ public class ColumnInfo {
@JsonProperty("comment")
private String comment;
- /** */
+ /**
+ * The column mask function applied to this column, if any. A column mask is a SQL user-defined
+ * function that transforms the values a query returns for the column. See
+ * https://docs.databricks.com/aws/en/tables/row-and-column-filters for details.
+ */
@JsonProperty("mask")
private ColumnMask mask;
@@ -41,7 +45,11 @@ public class ColumnInfo {
@JsonProperty("type_json")
private String typeJson;
- /** */
+ /**
+ * The name of the column's data type, for example STRING, DECIMAL or STRUCT. The complete type,
+ * including parameters such as the precision of a decimal or the element type of an array, is in
+ * type_text.
+ */
@JsonProperty("type_name")
private ColumnTypeName typeName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMcpServiceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMcpServiceRequest.java
index 556f88ee2..72da62573 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMcpServiceRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateMcpServiceRequest.java
@@ -18,7 +18,10 @@ public class CreateMcpServiceRequest {
@JsonProperty("mcp_service")
private McpService mcpService;
- /** Name for the MCP service, e.g. "my_mcp_service". */
+ /**
+ * Name of the MCP service within the parent schema. The name must not contain periods, spaces,
+ * forward slashes, percent signs, or control characters, and it is stored in lowercase.
+ */
@JsonIgnore
@QueryParam("mcp_service_id")
private String mcpServiceId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelProviderServiceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelProviderServiceRequest.java
index d15068a87..acf1049a1 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelProviderServiceRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateModelProviderServiceRequest.java
@@ -18,7 +18,11 @@ public class CreateModelProviderServiceRequest {
@JsonProperty("model_provider_service")
private ModelProviderService modelProviderService;
- /** Name for the model provider service, e.g. "openai_prod". */
+ /**
+ * Name of the model provider service within the parent schema. The name must not contain periods,
+ * spaces, forward slashes, percent signs, or control characters, must not end in
+ * `_DO_NOT_MODIFY`, and must not exceed 241 characters. It is stored in lowercase.
+ */
@JsonIgnore
@QueryParam("model_provider_service_id")
private String modelProviderServiceId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateSchema.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateSchema.java
index 4d0601f9b..92ca40694 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateSchema.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateSchema.java
@@ -18,7 +18,11 @@ public class CreateSchema {
@JsonProperty("comment")
private String comment;
- /** Custom maximum retention period in hours for the schema. */
+ /**
+ * Dropped objects in the schema remain recoverable for this number of hours before they are
+ * permanently purged. The value must be 0 or within the range allowed for the metastore. Schemas
+ * that do not set their own value inherit the parent catalog's value.
+ */
@JsonProperty("custom_max_retention_hours")
private Long customMaxRetentionHours;
@@ -30,7 +34,13 @@ public class CreateSchema {
@JsonProperty("properties")
private Map properties;
- /** Storage root URL for managed tables within schema. */
+ /**
+ * Managed tables and volumes in the schema are stored under this storage root URL. The path must
+ * be inside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If
+ * omitted, managed data is stored under the parent catalog's storage root, or under the
+ * metastore's root storage location when the catalog has none. Schemas in Delta Sharing catalogs
+ * cannot have a storage root, and schemas in a federated Hive metastore catalog must set one.
+ */
@JsonProperty("storage_root")
private String storageRoot;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateTableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateTableRequest.java
index efd4bdcf9..9c442721e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateTableRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/CreateTableRequest.java
@@ -19,7 +19,11 @@ public class CreateTableRequest {
@JsonProperty("columns")
private Collection columns;
- /** */
+ /**
+ * The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign
+ * tables report the external system that holds them, for example SNOWFLAKE_FORMAT or
+ * MYSQL_FORMAT.
+ */
@JsonProperty("data_source_format")
private DataSourceFormat dataSourceFormat;
@@ -35,11 +39,22 @@ public class CreateTableRequest {
@JsonProperty("schema_name")
private String schemaName;
- /** Storage root URL for table (for **MANAGED**, **EXTERNAL** tables). */
+ /**
+ * The cloud storage URL under which the data files of the table are stored. For an EXTERNAL
+ * table, it must be set on creation to a path within an existing external location. For a MANAGED
+ * table, the server assigns a path under the managed storage location of the parent schema,
+ * catalog or metastore and returns it in this field. Views have no storage location.
+ */
@JsonProperty("storage_location")
private String storageLocation;
- /** */
+ /**
+ * The type of the table. MANAGED tables store their data in storage that Unity Catalog manages,
+ * EXTERNAL tables store it in a registered external location, FOREIGN tables mirror objects of an
+ * external database through a connection, and the shallow clone types reference the data files of
+ * a base table. VIEW, MATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view
+ * definition. See https://docs.databricks.com/aws/en/tables/ for an overview of the table types.
+ */
@JsonProperty("table_type")
private TableType tableType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSchemaRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSchemaRequest.java
index 067b55898..989bcb97a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSchemaRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteSchemaRequest.java
@@ -15,7 +15,7 @@ public class DeleteSchemaRequest {
@QueryParam("force")
private Boolean force;
- /** Full name of the schema. */
+ /** Full name of the schema, in the form catalog_name.schema_name. */
@JsonIgnore private String fullName;
public DeleteSchemaRequest setForce(Boolean force) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DisableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DisableRequest.java
index 5ff7d0818..6e34342e5 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DisableRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DisableRequest.java
@@ -12,7 +12,7 @@ public class DisableRequest {
/** The metastore ID under which the system schema lives. */
@JsonIgnore private String metastoreId;
- /** Full name of the system schema. */
+ /** Name of the system schema, without the catalog prefix. */
@JsonIgnore private String schemaName;
public DisableRequest setMetastoreId(String metastoreId) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EnableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EnableRequest.java
index 7a0a9a477..276282433 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EnableRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/EnableRequest.java
@@ -10,14 +10,17 @@
@Generated
public class EnableRequest {
- /** the catalog for which the system schema is to enabled in */
+ /**
+ * Name of the catalog in which to enable the system schema. The supported values are `system` and
+ * `samples`. If not set, the system schema is enabled in the `system` catalog.
+ */
@JsonProperty("catalog_name")
private String catalogName;
/** The metastore ID under which the system schema lives. */
@JsonIgnore private String metastoreId;
- /** Full name of the system schema. */
+ /** Name of the system schema, without the catalog prefix. */
@JsonIgnore private String schemaName;
public EnableRequest setCatalogName(String catalogName) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSchemaRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSchemaRequest.java
index 02d0517e8..a64d1e771 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSchemaRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetSchemaRequest.java
@@ -10,12 +10,12 @@
@Generated
public class GetSchemaRequest {
- /** Full name of the schema. */
+ /** Full name of the schema, in the form catalog_name.schema_name. */
@JsonIgnore private String fullName;
/**
- * Whether to include schemas in the response for which the principal can only access selective
- * metadata for
+ * Whether to return the schema when the principal can only access selective metadata for it
+ * through the BROWSE privilege. The response then has browse_only set to true.
*/
@JsonIgnore
@QueryParam("include_browse")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java
index 5fe266596..2fc8a0794 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListSchemasRequest.java
@@ -16,8 +16,8 @@ public class ListSchemasRequest {
private String catalogName;
/**
- * Whether to include schemas in the response for which the principal can only access selective
- * metadata for
+ * Whether to include schemas for which the principal can only access selective metadata through
+ * the BROWSE privilege. Such schemas are returned with browse_only set to true.
*/
@JsonIgnore
@QueryParam("include_browse")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/McpService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/McpService.java
index 7bf598460..4625e20bc 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/McpService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/McpService.java
@@ -29,11 +29,11 @@ public class McpService {
@JsonProperty("create_time")
private Timestamp createTime;
- /** Creator identity. */
+ /** Username or service principal application ID of the principal that created the MCP service. */
@JsonProperty("created_by")
private String createdBy;
- /** Owner of the MCP service. */
+ /** Username, group name, or service principal application ID of the MCP service owner. */
@JsonProperty("effective_owner")
private String effectiveOwner;
@@ -45,14 +45,15 @@ public class McpService {
@JsonProperty("etag")
private String etag;
- /** Metastore hosting the MCP service. */
+ /** Unique identifier of the metastore that contains the MCP service. */
@JsonProperty("metastore_id")
private String metastoreId;
/**
* Resource name of the MCP service. Format: `mcp-services/{catalog}.{schema}.{mcp_service}`. Each
- * `{...}` component is capped at 255 characters individually. Server-derived on Create from
- * `parent` + `mcp_service_id`; required and immutable on Update/Get/Delete.
+ * `{...}` component is capped at 255 characters individually. The server derives the name on
+ * Create from `parent` and `mcp_service_id`; it is required and immutable on Update, Get, and
+ * Delete.
*/
@JsonProperty("name")
private String name;
@@ -61,7 +62,10 @@ public class McpService {
@JsonProperty("update_time")
private Timestamp updateTime;
- /** Identity of the last updater. */
+ /**
+ * Username or service principal application ID of the principal that last updated the MCP
+ * service.
+ */
@JsonProperty("updated_by")
private String updatedBy;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderService.java
index 5514df383..9ba334112 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderService.java
@@ -34,11 +34,11 @@ public class ModelProviderService {
@JsonProperty("create_time")
private Timestamp createTime;
- /** Creator identity. */
+ /** Username of the user who created the model provider service. */
@JsonProperty("created_by")
private String createdBy;
- /** Owner of the model provider service. */
+ /** Username or group name of the model provider service owner. */
@JsonProperty("effective_owner")
private String effectiveOwner;
@@ -50,15 +50,15 @@ public class ModelProviderService {
@JsonProperty("etag")
private String etag;
- /** Metastore hosting the provider service. */
+ /** Unique identifier of the metastore that contains the model provider service. */
@JsonProperty("metastore_id")
private String metastoreId;
/**
* Resource name of the provider service. Format:
* `model-provider-services/{catalog}.{schema}.{model_provider_service}`. Each `{...}` component
- * is capped at 255 characters individually. Server-derived on Create from `parent` +
- * `model_provider_service_id`; required and immutable on Update/Get/Delete.
+ * is capped at 255 characters individually. The server derives the name on Create from `parent`
+ * and `model_provider_service_id`; it is required and immutable on Update, Get, and Delete.
*/
@JsonProperty("name")
private String name;
@@ -67,7 +67,7 @@ public class ModelProviderService {
@JsonProperty("update_time")
private Timestamp updateTime;
- /** Identity of the last updater. */
+ /** Username of the user who last updated the model provider service. */
@JsonProperty("updated_by")
private String updatedBy;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfig.java
index 1112075ea..e9a39d5b1 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfig.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfig.java
@@ -25,23 +25,38 @@ public class ModelProviderServiceConfig {
@JsonProperty("allow_all_targets")
private Boolean allowAllTargets;
- /** */
+ /**
+ * Configuration for Amazon Bedrock. Set this field when `provider_type` is
+ * `EXTERNAL_MODEL_PROVIDER_TYPE_AMAZON_BEDROCK`.
+ */
@JsonProperty("amazon_bedrock")
private ModelProviderServiceConfigAmazonBedrockProviderConfig amazonBedrock;
- /** */
+ /**
+ * Configuration for Anthropic. Set this field when `provider_type` is
+ * `EXTERNAL_MODEL_PROVIDER_TYPE_ANTHROPIC`.
+ */
@JsonProperty("anthropic")
private ModelProviderServiceConfigAnthropicProviderConfig anthropic;
- /** */
+ /**
+ * Configuration for Azure OpenAI. Set this field when `provider_type` is
+ * `EXTERNAL_MODEL_PROVIDER_TYPE_AZURE_OPENAI`.
+ */
@JsonProperty("azure_openai")
private ModelProviderServiceConfigAzureOpenAiProviderConfig azureOpenai;
- /** */
+ /**
+ * Configuration for Amazon Bedrock Mantle, with the same fields as `amazon_bedrock`. Set this
+ * field when `provider_type` is `EXTERNAL_MODEL_PROVIDER_TYPE_BEDROCK_MANTLE`.
+ */
@JsonProperty("bedrock_mantle")
private ModelProviderServiceConfigAmazonBedrockProviderConfig bedrockMantle;
- /** */
+ /**
+ * Configuration for a custom OpenAI-compatible provider. Set this field when `provider_type` is
+ * `EXTERNAL_MODEL_PROVIDER_TYPE_CUSTOM`.
+ */
@JsonProperty("custom")
private ModelProviderServiceConfigCustomProviderConfig custom;
@@ -71,7 +86,10 @@ public class ModelProviderServiceConfig {
@JsonProperty("forward_unmanaged_paths")
private Boolean forwardUnmanagedPaths;
- /** */
+ /**
+ * Configuration for Google Gemini Enterprise. Set this field when `provider_type` is
+ * `EXTERNAL_MODEL_PROVIDER_TYPE_GEMINI_ENTERPRISE`.
+ */
@JsonProperty("gemini_enterprise")
private ModelProviderServiceConfigGeminiEnterpriseProviderConfig geminiEnterprise;
@@ -82,11 +100,17 @@ public class ModelProviderServiceConfig {
@JsonProperty("inference_table")
private InferenceTableConfig inferenceTable;
- /** */
+ /**
+ * Configuration for Microsoft Foundry. Set this field when `provider_type` is
+ * `EXTERNAL_MODEL_PROVIDER_TYPE_MICROSOFT_FOUNDRY`.
+ */
@JsonProperty("microsoft_foundry")
private ModelProviderServiceConfigMicrosoftFoundryProviderConfig microsoftFoundry;
- /** */
+ /**
+ * Configuration for OpenAI. Set this field when `provider_type` is
+ * `EXTERNAL_MODEL_PROVIDER_TYPE_OPENAI`.
+ */
@JsonProperty("openai")
private ModelProviderServiceConfigOpenAiProviderConfig openai;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth.java
index 86f51ac71..6883cfeab 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth.java
@@ -22,8 +22,8 @@ public class ModelProviderServiceConfigCustomProviderApiKeyHeaderAuth {
private String apiKeyName;
/**
- * Secret value forwarded under the `api_key_name` header on outbound requests. Supplied as inline
- * plaintext via `ProviderSecret.plaintext`.
+ * Secret value forwarded under the `api_key_name` header on outbound requests. Supply the value
+ * in `api_key_value.plaintext`.
*/
@JsonProperty("api_key_value")
private ModelProviderServiceConfigProviderSecret apiKeyValue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigProviderSecret.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigProviderSecret.java
index fd27145e3..d8ef6edc0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigProviderSecret.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ModelProviderServiceConfigProviderSecret.java
@@ -15,8 +15,8 @@
@Generated
public class ModelProviderServiceConfigProviderSecret {
/**
- * Inline plaintext credential. INPUT_ONLY: the value never round-trips on reads. Get and List
- * responses omit `plaintext`; the enclosing secret object remains present to indicate that a
+ * Inline plaintext credential. The value is write-only and never round-trips on reads. Get and
+ * List responses omit `plaintext`; the enclosing secret object remains present to indicate that a
* secret is configured.
*/
@JsonProperty("plaintext")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java
index 593560059..c8f914f41 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SchemaInfo.java
@@ -8,6 +8,12 @@
import java.util.Map;
import java.util.Objects;
+/**
+ * A schema (also called a database) is the second layer of Unity Catalog's three-level namespace
+ * and groups the tables, views, volumes, models, and functions under its parent catalog. Managed
+ * tables and volumes in the schema are stored under the schema's storage root when it has one, and
+ * otherwise under the storage of the parent catalog or the metastore.
+ */
@Generated
public class SchemaInfo {
/**
@@ -21,7 +27,7 @@ public class SchemaInfo {
@JsonProperty("catalog_name")
private String catalogName;
- /** The type of the parent catalog. */
+ /** The type of the parent catalog, which the server copies from the catalog. */
@JsonProperty("catalog_type")
private CatalogType catalogType;
@@ -37,15 +43,27 @@ public class SchemaInfo {
@JsonProperty("created_by")
private String createdBy;
- /** Custom maximum retention period in hours for the schema. */
+ /**
+ * Dropped objects in the schema remain recoverable for this number of hours before they are
+ * permanently purged. The value must be 0 or within the range allowed for the metastore. Schemas
+ * that do not set their own value inherit the parent catalog's value.
+ */
@JsonProperty("custom_max_retention_hours")
private Long customMaxRetentionHours;
- /** */
+ /**
+ * Indicates the predictive optimization setting that is in effect for the schema once inherited
+ * values are resolved.
+ */
@JsonProperty("effective_predictive_optimization_flag")
private EffectivePredictiveOptimizationFlag effectivePredictiveOptimizationFlag;
- /** Whether predictive optimization should be enabled for this object and objects under it. */
+ /**
+ * Whether predictive optimization is enabled for this schema and the objects under it. Valid
+ * values are ENABLE, DISABLE, and INHERIT, where INHERIT applies the parent catalog's setting.
+ * New schemas start as INHERIT. It cannot be set when creating a schema; use the update method
+ * instead.
+ */
@JsonProperty("enable_predictive_optimization")
private EnablePredictiveOptimization enablePredictiveOptimization;
@@ -61,7 +79,10 @@ public class SchemaInfo {
@JsonProperty("name")
private String name;
- /** Username of current owner of schema. */
+ /**
+ * The user or group that owns the schema. The creator becomes the owner, and the owner can be
+ * changed only through the update method.
+ */
@JsonProperty("owner")
private String owner;
@@ -69,19 +90,29 @@ public class SchemaInfo {
@JsonProperty("properties")
private Map properties;
- /** The unique identifier of the schema. */
+ /** The unique identifier (UUID) that the server assigns to the schema when it is created. */
@JsonProperty("schema_id")
private String schemaId;
- /** Storage location for managed tables within schema. */
+ /**
+ * The server derives this full storage location URL for managed tables and volumes within the
+ * schema from storage_root and the schema ID. It is absent when the schema has no storage root of
+ * its own.
+ */
@JsonProperty("storage_location")
private String storageLocation;
- /** Storage root URL for managed tables within schema. */
+ /**
+ * Managed tables and volumes in the schema are stored under this storage root URL. The path must
+ * be inside an external location on which the caller has the CREATE MANAGED STORAGE privilege. If
+ * omitted, managed data is stored under the parent catalog's storage root, or under the
+ * metastore's root storage location when the catalog has none. Schemas in Delta Sharing catalogs
+ * cannot have a storage root, and schemas in a federated Hive metastore catalog must set one.
+ */
@JsonProperty("storage_root")
private String storageRoot;
- /** Time at which this schema was created, in epoch milliseconds. */
+ /** Time at which this schema was last modified, in epoch milliseconds. */
@JsonProperty("updated_at")
private Long updatedAt;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemaInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemaInfo.java
index 3451b1ea1..46eccd290 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemaInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/SystemSchemaInfo.java
@@ -7,16 +7,24 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * A system schema of a metastore, with its current enablement state. System schemas hold
+ * Databricks-provided system tables, such as audit logs and billing usage. They live in the
+ * `system` catalog unless they are enabled in another supported catalog. See
+ * https://docs.databricks.com/aws/en/admin/system-tables/.
+ */
@Generated
public class SystemSchemaInfo {
- /** Name of the system schema. */
+ /** Name of the system schema, without the catalog prefix. */
@JsonProperty("schema")
private String schema;
/**
- * The current state of enablement for the system schema. An empty string means the system schema
- * is available and ready for opt-in. Possible values: AVAILABLE | ENABLE_INITIALIZED |
- * ENABLE_COMPLETED | DISABLE_INITIALIZED | UNAVAILABLE | MANAGED
+ * The current enablement state of the system schema. Possible values are `AVAILABLE` (the schema
+ * can be enabled), `ENABLE_INITIALIZED` (enablement is in progress), `ENABLE_COMPLETED` (the
+ * schema is enabled), `DISABLE_INITIALIZED` (disablement is in progress), `UNAVAILABLE` (the
+ * schema cannot be enabled at the moment) and `MANAGED` (Databricks enables the schema
+ * automatically).
*/
@JsonProperty("state")
private String state;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java
index cbe5577c2..8aedd06ae 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableInfo.java
@@ -9,9 +9,15 @@
import java.util.Map;
import java.util.Objects;
+/**
+ * A table resides in the third layer of Unity Catalog's three-level namespace and holds rows of
+ * data organized in columns. Besides managed and external tables, it covers views, materialized
+ * views, streaming tables, metric views, foreign tables and shallow clones, which table_type
+ * distinguishes.
+ */
@Generated
public class TableInfo {
- /** The AWS access point to use when accesing s3 for this external location. */
+ /** The AWS access point to use when accessing S3 for the storage location of this table. */
@JsonProperty("access_point")
private String accessPoint;
@@ -46,7 +52,11 @@ public class TableInfo {
@JsonProperty("data_access_configuration_id")
private String dataAccessConfigurationId;
- /** */
+ /**
+ * The format of the data that backs the table, such as DELTA, PARQUET, CSV or JSON. Foreign
+ * tables report the external system that holds them, for example SNOWFLAKE_FORMAT or
+ * MYSQL_FORMAT.
+ */
@JsonProperty("data_source_format")
private DataSourceFormat dataSourceFormat;
@@ -61,11 +71,19 @@ public class TableInfo {
@JsonProperty("delta_runtime_properties_kvpairs")
private DeltaRuntimePropertiesKvPairs deltaRuntimePropertiesKvpairs;
- /** */
+ /**
+ * The predictive optimization setting that is in effect for the table once inherited values are
+ * resolved.
+ */
@JsonProperty("effective_predictive_optimization_flag")
private EffectivePredictiveOptimizationFlag effectivePredictiveOptimizationFlag;
- /** */
+ /**
+ * Whether predictive optimization is enabled for this table. Valid values are ENABLE, DISABLE and
+ * INHERIT, where INHERIT applies the setting of the parent schema. It is ignored when creating a
+ * table. See https://docs.databricks.com/aws/en/optimizations/predictive-optimization for
+ * details.
+ */
@JsonProperty("enable_predictive_optimization")
private EnablePredictiveOptimization enablePredictiveOptimization;
@@ -85,7 +103,9 @@ public class TableInfo {
@JsonProperty("name")
private String name;
- /** Username of current owner of table. */
+ /**
+ * The user or group that owns the table. The principal that creates the table becomes its owner.
+ */
@JsonProperty("owner")
private String owner;
@@ -100,7 +120,11 @@ public class TableInfo {
@JsonProperty("properties")
private Map properties;
- /** */
+ /**
+ * The row filter function applied to the table, if any. A row filter is a SQL user-defined
+ * function that decides which rows a query returns. See
+ * https://docs.databricks.com/aws/en/tables/row-and-column-filters for details.
+ */
@JsonProperty("row_filter")
private TableRowFilter rowFilter;
@@ -123,7 +147,12 @@ public class TableInfo {
@JsonProperty("storage_credential_name")
private String storageCredentialName;
- /** Storage root URL for table (for **MANAGED**, **EXTERNAL** tables). */
+ /**
+ * The cloud storage URL under which the data files of the table are stored. For an EXTERNAL
+ * table, it must be set on creation to a path within an existing external location. For a MANAGED
+ * table, the server assigns a path under the managed storage location of the parent schema,
+ * catalog or metastore and returns it in this field. Views have no storage location.
+ */
@JsonProperty("storage_location")
private String storageLocation;
@@ -137,7 +166,13 @@ public class TableInfo {
@JsonProperty("table_id")
private String tableId;
- /** */
+ /**
+ * The type of the table. MANAGED tables store their data in storage that Unity Catalog manages,
+ * EXTERNAL tables store it in a registered external location, FOREIGN tables mirror objects of an
+ * external database through a connection, and the shallow clone types reference the data files of
+ * a base table. VIEW, MATERIALIZED_VIEW, STREAMING_TABLE and METRIC_VIEW are defined by a view
+ * definition. See https://docs.databricks.com/aws/en/tables/ for an overview of the table types.
+ */
@JsonProperty("table_type")
private TableType tableType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableSummary.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableSummary.java
index 515394c42..c01f67762 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableSummary.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/TableSummary.java
@@ -17,7 +17,7 @@ public class TableSummary {
@JsonProperty("securable_kind_manifest")
private SecurableKindManifest securableKindManifest;
- /** */
+ /** The type of the table, with the same meaning as table_type on TableInfo. */
@JsonProperty("table_type")
private TableType tableType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMcpServiceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMcpServiceRequest.java
index e7350c783..056209ffa 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMcpServiceRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateMcpServiceRequest.java
@@ -31,8 +31,9 @@ public class UpdateMcpServiceRequest {
/**
* Resource name of the MCP service. Format: `mcp-services/{catalog}.{schema}.{mcp_service}`. Each
- * `{...}` component is capped at 255 characters individually. Server-derived on Create from
- * `parent` + `mcp_service_id`; required and immutable on Update/Get/Delete.
+ * `{...}` component is capped at 255 characters individually. The server derives the name on
+ * Create from `parent` and `mcp_service_id`; it is required and immutable on Update, Get, and
+ * Delete.
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelProviderServiceRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelProviderServiceRequest.java
index 931db8110..4071d775d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelProviderServiceRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateModelProviderServiceRequest.java
@@ -32,8 +32,8 @@ public class UpdateModelProviderServiceRequest {
/**
* Resource name of the provider service. Format:
* `model-provider-services/{catalog}.{schema}.{model_provider_service}`. Each `{...}` component
- * is capped at 255 characters individually. Server-derived on Create from `parent` +
- * `model_provider_service_id`; required and immutable on Update/Get/Delete.
+ * is capped at 255 characters individually. The server derives the name on Create from `parent`
+ * and `model_provider_service_id`; it is required and immutable on Update, Get, and Delete.
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSchema.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSchema.java
index 79c4f7141..85d65e76c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSchema.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateSchema.java
@@ -15,22 +15,34 @@ public class UpdateSchema {
@JsonProperty("comment")
private String comment;
- /** Custom maximum retention period in hours for the schema. */
+ /**
+ * Dropped objects in the schema remain recoverable for this number of hours before they are
+ * permanently purged. The value must be 0 or within the range allowed for the metastore. Schemas
+ * that do not set their own value inherit the parent catalog's value.
+ */
@JsonProperty("custom_max_retention_hours")
private Long customMaxRetentionHours;
- /** Whether predictive optimization should be enabled for this object and objects under it. */
+ /**
+ * Whether predictive optimization is enabled for this schema and the objects under it. Valid
+ * values are ENABLE, DISABLE, and INHERIT, where INHERIT applies the parent catalog's setting.
+ * New schemas start as INHERIT. It cannot be set when creating a schema; use the update method
+ * instead.
+ */
@JsonProperty("enable_predictive_optimization")
private EnablePredictiveOptimization enablePredictiveOptimization;
- /** Full name of the schema. */
+ /** Full name of the schema, in the form catalog_name.schema_name. */
@JsonIgnore private String fullName;
/** New name for the schema. */
@JsonProperty("new_name")
private String newName;
- /** Username of current owner of schema. */
+ /**
+ * The user or group that owns the schema. The creator becomes the owner, and the owner can be
+ * changed only through the update method.
+ */
@JsonProperty("owner")
private String owner;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateTableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateTableRequest.java
index f58635082..69d1cc9e0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateTableRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateTableRequest.java
@@ -13,7 +13,9 @@ public class UpdateTableRequest {
/** Full name of the table. */
@JsonIgnore private String fullName;
- /** Username of current owner of table. */
+ /**
+ * The user or group that owns the table. The principal that creates the table becomes its owner.
+ */
@JsonProperty("owner")
private String owner;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java
index aa54a8aad..36d4e12fb 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoom.java
@@ -7,6 +7,13 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * A clean room is a secure, Databricks-managed environment where collaborators from one or more
+ * Unity Catalog metastores share tables, views, volumes and notebooks and run approved analyses
+ * without seeing each other's data. Each collaborator sees the clean room as a securable in their
+ * own metastore, while the analyses run in a central clean room in the cloud and region chosen at
+ * creation.
+ */
@Generated
public class CleanRoom {
/**
@@ -17,7 +24,10 @@ public class CleanRoom {
@JsonProperty("access_restricted")
private CleanRoomAccessRestricted accessRestricted;
- /** */
+ /**
+ * Free-form description of the clean room. Comments are local to the caller's metastore and are
+ * not shared with the other collaborators.
+ */
@JsonProperty("comment")
private String comment;
@@ -55,7 +65,7 @@ public class CleanRoom {
/**
* This is the Databricks username of the owner of the local clean room securable for permission
- * management.
+ * management. When creating a clean room, leave it empty or set it to the caller.
*/
@JsonProperty("owner")
private String owner;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java
index eb864a9ee..7ddc3f8d2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomOutputCatalog.java
@@ -19,7 +19,7 @@ public class CleanRoomOutputCatalog {
@JsonProperty("catalog_name")
private String catalogName;
- /** */
+ /** Status of the output catalog for the calling collaborator. */
@JsonProperty("status")
private CleanRoomOutputCatalogOutputCatalogStatus status;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java
index 3c0985419..c4fadfd0c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomRemoteDetail.java
@@ -20,8 +20,8 @@ public class CleanRoomRemoteDetail {
private String cloudVendor;
/**
- * Collaborators in the central clean room. There should one and only one collaborator in the list
- * that satisfies the owner condition:
+ * Collaborators in the central clean room. There should be one and only one collaborator in the
+ * list that satisfies the owner condition:
*
* 1. It has the creator's global_metastore_id (determined by caller of CreateCleanRoom).
*
@@ -30,7 +30,11 @@ public class CleanRoomRemoteDetail {
@JsonProperty("collaborators")
private Collection collaborators;
- /** */
+ /**
+ * Compliance security profile of the central clean room. It is taken from the creator's workspace
+ * when the clean room is created; a collaborator whose workspace profile differs sees
+ * access_restricted set to CSP_MISMATCH.
+ */
@JsonProperty("compliance_security_profile")
private ComplianceSecurityProfile complianceSecurityProfile;
@@ -38,7 +42,12 @@ public class CleanRoomRemoteDetail {
@JsonProperty("creator")
private CleanRoomCollaborator creator;
- /** Egress network policy to apply to the central clean room workspace. */
+ /**
+ * Egress network policy to apply to the central clean room workspace. Only
+ * internet_access.restriction_mode (FULL_ACCESS or RESTRICTED_ACCESS) and
+ * internet_access.allowed_internet_destinations can be set. When omitted, internet access is
+ * restricted with no allowed destinations.
+ */
@JsonProperty("egress_network_policy")
private com.databricks.sdk.service.settings.EgressNetworkPolicy egressNetworkPolicy;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsAPI.java
index d1a028851..0da459c25 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsAPI.java
@@ -73,11 +73,11 @@ public CleanRoom waitGetCleanRoomActive(
}
/**
- * Create a new clean room with the specified collaborators. This method is asynchronous; the
- * returned name field inside the clean_room field can be used to poll the clean room status,
- * using the [cleanrooms/get] method. When this method returns, the clean room will be in a
- * PROVISIONING state, with only name, owner, comment, created_at and status populated. The clean
- * room will be usable once it enters an ACTIVE state.
+ * Create a new clean room with the specified collaborators. This method is asynchronous; the name
+ * field of the returned clean room can be used to poll the clean room status, using the
+ * [cleanrooms/get] method. When this method returns, the clean room will be in a PROVISIONING
+ * state, with only name, owner, comment, created_at and status populated. The clean room will be
+ * usable once it enters an ACTIVE state.
*
* The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the
* metastore.
@@ -91,7 +91,12 @@ public Wait create(CreateCleanRoomRequest request) {
response);
}
- /** Create the output catalog of the clean room. */
+ /**
+ * Create the output catalog of the clean room. The output catalog is a catalog in the caller's
+ * metastore where the output tables of the clean room runs that the caller triggers are made
+ * available. Each collaborator can create one output catalog per clean room, and the clean room
+ * must be ACTIVE.
+ */
public CreateCleanRoomOutputCatalogResponse createOutputCatalog(
CreateCleanRoomOutputCatalogRequest request) {
return impl.createOutputCatalog(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java
index c945f99c1..c4a6699ff 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CleanRoomsService.java
@@ -15,11 +15,11 @@
@Generated
public interface CleanRoomsService {
/**
- * Create a new clean room with the specified collaborators. This method is asynchronous; the
- * returned name field inside the clean_room field can be used to poll the clean room status,
- * using the [cleanrooms/get] method. When this method returns, the clean room will be in a
- * PROVISIONING state, with only name, owner, comment, created_at and status populated. The clean
- * room will be usable once it enters an ACTIVE state.
+ * Create a new clean room with the specified collaborators. This method is asynchronous; the name
+ * field of the returned clean room can be used to poll the clean room status, using the
+ * [cleanrooms/get] method. When this method returns, the clean room will be in a PROVISIONING
+ * state, with only name, owner, comment, created_at and status populated. The clean room will be
+ * usable once it enters an ACTIVE state.
*
* The caller must be a metastore admin or have the **CREATE_CLEAN_ROOM** privilege on the
* metastore.
@@ -28,7 +28,12 @@ public interface CleanRoomsService {
*/
CleanRoom create(CreateCleanRoomRequest createCleanRoomRequest);
- /** Create the output catalog of the clean room. */
+ /**
+ * Create the output catalog of the clean room. The output catalog is a catalog in the caller's
+ * metastore where the output tables of the clean room runs that the caller triggers are made
+ * available. Each collaborator can create one output catalog per clean room, and the clean room
+ * must be ACTIVE.
+ */
CreateCleanRoomOutputCatalogResponse createOutputCatalog(
CreateCleanRoomOutputCatalogRequest createCleanRoomOutputCatalogRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CreateCleanRoomOutputCatalogResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CreateCleanRoomOutputCatalogResponse.java
index 05732e12f..6edf7d070 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CreateCleanRoomOutputCatalogResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/CreateCleanRoomOutputCatalogResponse.java
@@ -9,7 +9,7 @@
@Generated
public class CreateCleanRoomOutputCatalogResponse {
- /** */
+ /** The output catalog that was created. */
@JsonProperty("output_catalog")
private CleanRoomOutputCatalog outputCatalog;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/GetCleanRoomRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/GetCleanRoomRequest.java
index 60ebb1974..f1d7ae8fa 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/GetCleanRoomRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/GetCleanRoomRequest.java
@@ -9,7 +9,7 @@
@Generated
public class GetCleanRoomRequest {
- /** */
+ /** Name of the clean room. */
@JsonIgnore private String name;
public GetCleanRoomRequest setName(String name) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomRequest.java
index 32097e13a..b244ef218 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/cleanrooms/UpdateCleanRoomRequest.java
@@ -10,7 +10,11 @@
@Generated
public class UpdateCleanRoomRequest {
- /** */
+ /**
+ * Clean room fields to update. Only mutable fields such as owner, comment and
+ * enable_shared_output can be changed; remote_detailed_info, status, created_at and updated_at
+ * must be omitted.
+ */
@JsonProperty("clean_room")
private CleanRoom cleanRoom;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAttributes.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAttributes.java
index 82690ff99..c5f728aed 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAttributes.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AwsAttributes.java
@@ -10,7 +10,12 @@
/** Attributes set during cluster creation which are related to Amazon Web Services. */
@Generated
public class AwsAttributes {
- /** */
+ /**
+ * Availability type used for all subsequent nodes past the `first_on_demand` ones.
+ *
+ *
Note: If `first_on_demand` is zero, this availability type will be used for the entire
+ * cluster.
+ */
@JsonProperty("availability")
private AwsAvailability availability;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java
index bbe79b8b8..7d9c0fc55 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/AzureAttributes.java
@@ -47,7 +47,10 @@ public class AzureAttributes {
@JsonProperty("first_on_demand")
private Long firstOnDemand;
- /** Defines values necessary to configure and run Azure Log Analytics agent */
+ /**
+ * Defines values necessary to configure and run Azure Log Analytics agent. Both
+ * `log_analytics_workspace_id` and `log_analytics_primary_key` must be set, or neither.
+ */
@JsonProperty("log_analytics_info")
private LogAnalyticsInfo logAnalyticsInfo;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ChangeClusterOwner.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ChangeClusterOwner.java
index 2bd85e237..344be3db3 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ChangeClusterOwner.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ChangeClusterOwner.java
@@ -9,7 +9,7 @@
@Generated
public class ChangeClusterOwner {
- /** */
+ /** The ID of the cluster whose owner is changed. */
@JsonProperty("cluster_id")
private String clusterId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java
index 40bf8690f..cb6ad7892 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterAttributes.java
@@ -68,7 +68,34 @@ public class ClusterAttributes {
@JsonProperty("custom_tags")
private Map customTags;
- /** */
+ /**
+ * Data security mode decides what data governance model to use when accessing data from a
+ * cluster.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode
+ * depending on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that
+ * can be shared by multiple users. Cluster users are fully isolated so that they cannot see each
+ * other's data and credentials. Most data governance features are supported in this mode. But
+ * programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`:
+ * A secure cluster that can only be exclusively used by a single user specified in
+ * `single_user_name`. Most programming languages, cluster features and data governance features
+ * are available in this mode. * `NONE`: No security isolation for multiple users sharing the
+ * cluster. Data governance features are not available in this mode.
+ *
+ *
The following modes are legacy aliases for the above modes:
+ *
+ *
* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
+ * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ *
+ *
The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
+ * for future Databricks Runtime versions:
+ *
+ *
* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
+ * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
+ * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
+ * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way
+ * that doesn't have UC or passthrough enabled.
+ */
@JsonProperty("data_security_mode")
private DataSecurityMode dataSecurityMode;
@@ -76,7 +103,11 @@ public class ClusterAttributes {
@JsonProperty("dependency_mode")
private DependencyMode dependencyMode;
- /** Custom docker image BYOC */
+ /**
+ * Custom Docker image for the cluster's nodes, used with [Databricks Container Services].
+ *
+ *
[Databricks Container Services]: https://docs.databricks.com/compute/custom-containers.html
+ */
@JsonProperty("docker_image")
private DockerImage dockerImage;
@@ -137,7 +168,20 @@ public class ClusterAttributes {
@JsonProperty("is_single_node")
private Boolean isSingleNode;
- /** */
+ /**
+ * The kind of compute described by this compute specification.
+ *
+ *
Depending on `kind`, different validations and default values will be applied.
+ *
+ *
Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with
+ * no specified `kind` do not. * [is_single_node] * [use_ml_runtime]
+ *
+ *
By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ *
+ *
[is_single_node]: https://docs.databricks.com/api/workspace/clusters/create#is_single_node
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html [use_ml_runtime]:
+ * https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime
+ */
@JsonProperty("kind")
private Kind kind;
@@ -240,7 +284,10 @@ public class ClusterAttributes {
@JsonProperty("worker_node_type_flexibility")
private NodeTypeFlexibility workerNodeTypeFlexibility;
- /** */
+ /**
+ * Types of workloads that can use the cluster, such as notebooks or jobs. If omitted, the cluster
+ * can be used for both notebooks and jobs.
+ */
@JsonProperty("workload_type")
private WorkloadType workloadType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java
index 2e696fb09..4a8d8a35e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterDetails.java
@@ -109,7 +109,34 @@ public class ClusterDetails {
@JsonProperty("custom_tags")
private Map customTags;
- /** */
+ /**
+ * Data security mode decides what data governance model to use when accessing data from a
+ * cluster.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode
+ * depending on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that
+ * can be shared by multiple users. Cluster users are fully isolated so that they cannot see each
+ * other's data and credentials. Most data governance features are supported in this mode. But
+ * programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`:
+ * A secure cluster that can only be exclusively used by a single user specified in
+ * `single_user_name`. Most programming languages, cluster features and data governance features
+ * are available in this mode. * `NONE`: No security isolation for multiple users sharing the
+ * cluster. Data governance features are not available in this mode.
+ *
+ *
The following modes are legacy aliases for the above modes:
+ *
+ *
* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
+ * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ *
+ *
The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
+ * for future Databricks Runtime versions:
+ *
+ *
* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
+ * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
+ * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
+ * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way
+ * that doesn't have UC or passthrough enabled.
+ */
@JsonProperty("data_security_mode")
private DataSecurityMode dataSecurityMode;
@@ -133,7 +160,11 @@ public class ClusterDetails {
@JsonProperty("dependency_mode")
private DependencyMode dependencyMode;
- /** Custom docker image BYOC */
+ /**
+ * Custom Docker image for the cluster's nodes, used with [Databricks Container Services].
+ *
+ *
[Databricks Container Services]: https://docs.databricks.com/compute/custom-containers.html
+ */
@JsonProperty("docker_image")
private DockerImage dockerImage;
@@ -206,17 +237,30 @@ public class ClusterDetails {
private Boolean isSingleNode;
/**
- * Port on which Spark JDBC server is listening, in the driver nod. No service will be listeningon
+ * Port on which Spark JDBC server is listening in the driver node. No service will be listening
* on this port in executor nodes.
*/
@JsonProperty("jdbc_port")
private Long jdbcPort;
- /** */
+ /**
+ * The kind of compute described by this compute specification.
+ *
+ *
Depending on `kind`, different validations and default values will be applied.
+ *
+ *
Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with
+ * no specified `kind` do not. * [is_single_node] * [use_ml_runtime]
+ *
+ *
By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ *
+ *
[is_single_node]: https://docs.databricks.com/api/workspace/clusters/create#is_single_node
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html [use_ml_runtime]:
+ * https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime
+ */
@JsonProperty("kind")
private Kind kind;
- /** the timestamp that the cluster was started/restarted */
+ /** Time (in epoch milliseconds) when the cluster was last started or restarted. */
@JsonProperty("last_restarted_time")
private Long lastRestartedTime;
@@ -380,7 +424,10 @@ public class ClusterDetails {
@JsonProperty("worker_node_type_flexibility")
private NodeTypeFlexibility workerNodeTypeFlexibility;
- /** */
+ /**
+ * Types of workloads that can use the cluster, such as notebooks or jobs. If omitted, the cluster
+ * can be used for both notebooks and jobs.
+ */
@JsonProperty("workload_type")
private WorkloadType workloadType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterEvent.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterEvent.java
index c6bf7cd5c..daafb93ad 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterEvent.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterEvent.java
@@ -9,7 +9,7 @@
@Generated
public class ClusterEvent {
- /** */
+ /** The ID of the cluster the event belongs to. */
@JsonProperty("cluster_id")
private String clusterId;
@@ -17,7 +17,7 @@ public class ClusterEvent {
@JsonProperty("data_plane_event_details")
private DataPlaneEventDetails dataPlaneEventDetails;
- /** */
+ /** Details about the event. Which fields are populated depends on the event `type`. */
@JsonProperty("details")
private EventDetails details;
@@ -28,7 +28,7 @@ public class ClusterEvent {
@JsonProperty("timestamp")
private Long timestamp;
- /** */
+ /** The type of event, which determines which `details` fields are populated. */
@JsonProperty("type")
private EventType typeValue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java
index caa4f9380..2df952a1e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/ClusterSpec.java
@@ -82,7 +82,34 @@ public class ClusterSpec {
@JsonProperty("custom_tags")
private Map customTags;
- /** */
+ /**
+ * Data security mode decides what data governance model to use when accessing data from a
+ * cluster.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode
+ * depending on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that
+ * can be shared by multiple users. Cluster users are fully isolated so that they cannot see each
+ * other's data and credentials. Most data governance features are supported in this mode. But
+ * programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`:
+ * A secure cluster that can only be exclusively used by a single user specified in
+ * `single_user_name`. Most programming languages, cluster features and data governance features
+ * are available in this mode. * `NONE`: No security isolation for multiple users sharing the
+ * cluster. Data governance features are not available in this mode.
+ *
+ *
The following modes are legacy aliases for the above modes:
+ *
+ *
* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
+ * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ *
+ *
The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
+ * for future Databricks Runtime versions:
+ *
+ *
* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
+ * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
+ * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
+ * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way
+ * that doesn't have UC or passthrough enabled.
+ */
@JsonProperty("data_security_mode")
private DataSecurityMode dataSecurityMode;
@@ -90,7 +117,11 @@ public class ClusterSpec {
@JsonProperty("dependency_mode")
private DependencyMode dependencyMode;
- /** Custom docker image BYOC */
+ /**
+ * Custom Docker image for the cluster's nodes, used with [Databricks Container Services].
+ *
+ *
[Databricks Container Services]: https://docs.databricks.com/compute/custom-containers.html
+ */
@JsonProperty("docker_image")
private DockerImage dockerImage;
@@ -151,7 +182,20 @@ public class ClusterSpec {
@JsonProperty("is_single_node")
private Boolean isSingleNode;
- /** */
+ /**
+ * The kind of compute described by this compute specification.
+ *
+ *
Depending on `kind`, different validations and default values will be applied.
+ *
+ *
Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with
+ * no specified `kind` do not. * [is_single_node] * [use_ml_runtime]
+ *
+ *
By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ *
+ *
[is_single_node]: https://docs.databricks.com/api/workspace/clusters/create#is_single_node
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html [use_ml_runtime]:
+ * https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime
+ */
@JsonProperty("kind")
private Kind kind;
@@ -267,7 +311,10 @@ public class ClusterSpec {
@JsonProperty("worker_node_type_flexibility")
private NodeTypeFlexibility workerNodeTypeFlexibility;
- /** */
+ /**
+ * Types of workloads that can use the cluster, such as notebooks or jobs. If omitted, the cluster
+ * can be used for both notebooks and jobs.
+ */
@JsonProperty("workload_type")
private WorkloadType workloadType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java
index 0958b996d..8eac3936f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/CreateCluster.java
@@ -85,7 +85,34 @@ public class CreateCluster {
@JsonProperty("custom_tags")
private Map customTags;
- /** */
+ /**
+ * Data security mode decides what data governance model to use when accessing data from a
+ * cluster.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode
+ * depending on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that
+ * can be shared by multiple users. Cluster users are fully isolated so that they cannot see each
+ * other's data and credentials. Most data governance features are supported in this mode. But
+ * programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`:
+ * A secure cluster that can only be exclusively used by a single user specified in
+ * `single_user_name`. Most programming languages, cluster features and data governance features
+ * are available in this mode. * `NONE`: No security isolation for multiple users sharing the
+ * cluster. Data governance features are not available in this mode.
+ *
+ *
The following modes are legacy aliases for the above modes:
+ *
+ *
* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
+ * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ *
+ *
The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
+ * for future Databricks Runtime versions:
+ *
+ *
* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
+ * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
+ * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
+ * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way
+ * that doesn't have UC or passthrough enabled.
+ */
@JsonProperty("data_security_mode")
private DataSecurityMode dataSecurityMode;
@@ -93,7 +120,11 @@ public class CreateCluster {
@JsonProperty("dependency_mode")
private DependencyMode dependencyMode;
- /** Custom docker image BYOC */
+ /**
+ * Custom Docker image for the cluster's nodes, used with [Databricks Container Services].
+ *
+ *
[Databricks Container Services]: https://docs.databricks.com/compute/custom-containers.html
+ */
@JsonProperty("docker_image")
private DockerImage dockerImage;
@@ -154,7 +185,20 @@ public class CreateCluster {
@JsonProperty("is_single_node")
private Boolean isSingleNode;
- /** */
+ /**
+ * The kind of compute described by this compute specification.
+ *
+ *
Depending on `kind`, different validations and default values will be applied.
+ *
+ *
Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with
+ * no specified `kind` do not. * [is_single_node] * [use_ml_runtime]
+ *
+ *
By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ *
+ *
[is_single_node]: https://docs.databricks.com/api/workspace/clusters/create#is_single_node
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html [use_ml_runtime]:
+ * https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime
+ */
@JsonProperty("kind")
private Kind kind;
@@ -270,7 +314,10 @@ public class CreateCluster {
@JsonProperty("worker_node_type_flexibility")
private NodeTypeFlexibility workerNodeTypeFlexibility;
- /** */
+ /**
+ * Types of workloads that can use the cluster, such as notebooks or jobs. If omitted, the cluster
+ * can be used for both notebooks and jobs.
+ */
@JsonProperty("workload_type")
private WorkloadType workloadType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DockerBasicAuth.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DockerBasicAuth.java
index 58ff11bba..120ede38d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DockerBasicAuth.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/DockerBasicAuth.java
@@ -9,11 +9,11 @@
@Generated
public class DockerBasicAuth {
- /** Password of the user */
+ /** Password for authenticating to the Docker registry that hosts the image. */
@JsonProperty("password")
private String password;
- /** Name of the user */
+ /** User name for authenticating to the Docker registry that hosts the image. */
@JsonProperty("username")
private String username;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java
index f6863f72e..0d8be401c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EditCluster.java
@@ -82,7 +82,34 @@ public class EditCluster {
@JsonProperty("custom_tags")
private Map customTags;
- /** */
+ /**
+ * Data security mode decides what data governance model to use when accessing data from a
+ * cluster.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode
+ * depending on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that
+ * can be shared by multiple users. Cluster users are fully isolated so that they cannot see each
+ * other's data and credentials. Most data governance features are supported in this mode. But
+ * programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`:
+ * A secure cluster that can only be exclusively used by a single user specified in
+ * `single_user_name`. Most programming languages, cluster features and data governance features
+ * are available in this mode. * `NONE`: No security isolation for multiple users sharing the
+ * cluster. Data governance features are not available in this mode.
+ *
+ *
The following modes are legacy aliases for the above modes:
+ *
+ *
* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
+ * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ *
+ *
The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
+ * for future Databricks Runtime versions:
+ *
+ *
* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
+ * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
+ * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
+ * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way
+ * that doesn't have UC or passthrough enabled.
+ */
@JsonProperty("data_security_mode")
private DataSecurityMode dataSecurityMode;
@@ -90,7 +117,11 @@ public class EditCluster {
@JsonProperty("dependency_mode")
private DependencyMode dependencyMode;
- /** Custom docker image BYOC */
+ /**
+ * Custom Docker image for the cluster's nodes, used with [Databricks Container Services].
+ *
+ *
[Databricks Container Services]: https://docs.databricks.com/compute/custom-containers.html
+ */
@JsonProperty("docker_image")
private DockerImage dockerImage;
@@ -151,7 +182,20 @@ public class EditCluster {
@JsonProperty("is_single_node")
private Boolean isSingleNode;
- /** */
+ /**
+ * The kind of compute described by this compute specification.
+ *
+ *
Depending on `kind`, different validations and default values will be applied.
+ *
+ *
Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with
+ * no specified `kind` do not. * [is_single_node] * [use_ml_runtime]
+ *
+ *
By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ *
+ *
[is_single_node]: https://docs.databricks.com/api/workspace/clusters/create#is_single_node
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html [use_ml_runtime]:
+ * https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime
+ */
@JsonProperty("kind")
private Kind kind;
@@ -267,7 +311,10 @@ public class EditCluster {
@JsonProperty("worker_node_type_flexibility")
private NodeTypeFlexibility workerNodeTypeFlexibility;
- /** */
+ /**
+ * Types of workloads that can use the cluster, such as notebooks or jobs. If omitted, the cluster
+ * can be used for both notebooks and jobs.
+ */
@JsonProperty("workload_type")
private WorkloadType workloadType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EnforcePolicyComplianceForClusterResponseClusterSettings.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EnforcePolicyComplianceForClusterResponseClusterSettings.java
index c5451ad8c..557e15691 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EnforcePolicyComplianceForClusterResponseClusterSettings.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EnforcePolicyComplianceForClusterResponseClusterSettings.java
@@ -71,7 +71,34 @@ public class EnforcePolicyComplianceForClusterResponseClusterSettings {
@JsonProperty("custom_tags")
private Map customTags;
- /** */
+ /**
+ * Data security mode decides what data governance model to use when accessing data from a
+ * cluster.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode
+ * depending on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that
+ * can be shared by multiple users. Cluster users are fully isolated so that they cannot see each
+ * other's data and credentials. Most data governance features are supported in this mode. But
+ * programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`:
+ * A secure cluster that can only be exclusively used by a single user specified in
+ * `single_user_name`. Most programming languages, cluster features and data governance features
+ * are available in this mode. * `NONE`: No security isolation for multiple users sharing the
+ * cluster. Data governance features are not available in this mode.
+ *
+ *
The following modes are legacy aliases for the above modes:
+ *
+ *
* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
+ * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ *
+ *
The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
+ * for future Databricks Runtime versions:
+ *
+ *
* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
+ * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
+ * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
+ * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way
+ * that doesn't have UC or passthrough enabled.
+ */
@JsonProperty("data_security_mode")
private DataSecurityMode dataSecurityMode;
@@ -79,7 +106,11 @@ public class EnforcePolicyComplianceForClusterResponseClusterSettings {
@JsonProperty("dependency_mode")
private DependencyMode dependencyMode;
- /** Custom docker image BYOC */
+ /**
+ * Custom Docker image for the cluster's nodes, used with [Databricks Container Services].
+ *
+ *
[Databricks Container Services]: https://docs.databricks.com/compute/custom-containers.html
+ */
@JsonProperty("docker_image")
private DockerImage dockerImage;
@@ -140,7 +171,20 @@ public class EnforcePolicyComplianceForClusterResponseClusterSettings {
@JsonProperty("is_single_node")
private Boolean isSingleNode;
- /** */
+ /**
+ * The kind of compute described by this compute specification.
+ *
+ *
Depending on `kind`, different validations and default values will be applied.
+ *
+ *
Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with
+ * no specified `kind` do not. * [is_single_node] * [use_ml_runtime]
+ *
+ *
By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ *
+ *
[is_single_node]: https://docs.databricks.com/api/workspace/clusters/create#is_single_node
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html [use_ml_runtime]:
+ * https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime
+ */
@JsonProperty("kind")
private Kind kind;
@@ -256,7 +300,10 @@ public class EnforcePolicyComplianceForClusterResponseClusterSettings {
@JsonProperty("worker_node_type_flexibility")
private NodeTypeFlexibility workerNodeTypeFlexibility;
- /** */
+ /**
+ * Types of workloads that can use the cluster, such as notebooks or jobs. If omitted, the cluster
+ * can be used for both notebooks and jobs.
+ */
@JsonProperty("workload_type")
private WorkloadType workloadType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EventDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EventDetails.java
index a365e67d5..7afe84617 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EventDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/EventDetails.java
@@ -32,7 +32,10 @@ public class EventDetails {
@JsonProperty("current_num_workers")
private Long currentNumWorkers;
- /** */
+ /**
+ * The reason the disk was not expanded. Included in `DID_NOT_EXPAND_DISK` and
+ * `FAILED_TO_EXPAND_DISK` events.
+ */
@JsonProperty("did_not_expand_reason")
private String didNotExpandReason;
@@ -50,7 +53,10 @@ public class EventDetails {
@JsonProperty("enable_termination_for_node_blocklisted")
private Boolean enableTerminationForNodeBlocklisted;
- /** */
+ /**
+ * Free disk space in bytes. Included in disk expansion events such as `EXPANDED_DISK` and
+ * `DID_NOT_EXPAND_DISK`.
+ */
@JsonProperty("free_space")
private Long freeSpace;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetEventsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetEventsResponse.java
index 0ffb98a2d..ff18d8272 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetEventsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetEventsResponse.java
@@ -10,7 +10,7 @@
@Generated
public class GetEventsResponse {
- /** */
+ /** The events matching the request, in the requested `order`. */
@JsonProperty("events")
private Collection events;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java
index 488e06abb..42fa71be1 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesAPI.java
@@ -41,8 +41,10 @@ public LibrariesAPI(LibrariesService mock) {
}
/**
- * Get the status of all libraries on all clusters. A status is returned for all libraries
- * installed on this cluster via the API or the libraries UI.
+ * Get the status of all libraries on all clusters in the workspace. A status is returned for all
+ * libraries installed on each cluster via the API or the libraries UI. If the workspace has more
+ * library statuses than the response limit allows, the request fails; call the per-cluster status
+ * method for each cluster instead.
*/
public Iterable allClusterStatuses() {
return Paginator.newOffsetPagination(
@@ -61,7 +63,7 @@ public Iterable clusterStatus(String clusterId) {
* this cluster via the API or the libraries UI. The order of returned libraries is as follows: 1.
* Libraries set to be installed on this cluster, in the order that the libraries were added to
* the cluster, are returned first. 2. Libraries that were previously requested to be installed on
- * this cluster or, but are now marked for removal, in no particular order, are returned last.
+ * this cluster but are now marked for removal, in no particular order, are returned last.
*/
public Iterable clusterStatus(ClusterStatus request) {
return Paginator.newOffsetPagination(
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesService.java
index 5ccaf55cb..7a6bab7ed 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibrariesService.java
@@ -27,8 +27,10 @@
@Generated
public interface LibrariesService {
/**
- * Get the status of all libraries on all clusters. A status is returned for all libraries
- * installed on this cluster via the API or the libraries UI.
+ * Get the status of all libraries on all clusters in the workspace. A status is returned for all
+ * libraries installed on each cluster via the API or the libraries UI. If the workspace has more
+ * library statuses than the response limit allows, the request fails; call the per-cluster status
+ * method for each cluster instead.
*/
ListAllClusterLibraryStatusesResponse allClusterStatuses();
@@ -37,7 +39,7 @@ public interface LibrariesService {
* this cluster via the API or the libraries UI. The order of returned libraries is as follows: 1.
* Libraries set to be installed on this cluster, in the order that the libraries were added to
* the cluster, are returned first. 2. Libraries that were previously requested to be installed on
- * this cluster or, but are now marked for removal, in no particular order, are returned last.
+ * this cluster but are now marked for removal, in no particular order, are returned last.
*/
ClusterLibraryStatuses clusterStatus(ClusterStatus clusterStatus);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java
index f1be94bae..968c51d12 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/Library.java
@@ -7,15 +7,17 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/** A library to install on a cluster. Exactly one of the library-type fields must be set. */
@Generated
public class Library {
- /** Specification of a CRAN library to be installed as part of the library */
+ /** Specification of a CRAN library to be installed. */
@JsonProperty("cran")
private RCranLibrary cran;
/**
- * Deprecated. URI of the egg library to install. Installing Python egg files is deprecated and is
- * not supported in Databricks Runtime 14.0 and above.
+ * Deprecated: Installing Python egg files is not supported in Databricks Runtime 14.0 and above.
+ * Use a wheel (`whl`) or a PyPI package (`pypi`) instead. The value is the URI of the egg file to
+ * install.
*/
@JsonProperty("egg")
private String egg;
@@ -37,14 +39,15 @@ public class Library {
@JsonProperty("maven")
private MavenLibrary maven;
- /** Specification of a PyPi library to be installed. For example: `{ "package": "simplejson" }` */
+ /** Specification of a PyPI library to be installed. For example: `{ "package": "simplejson" }` */
@JsonProperty("pypi")
private PythonPyPiLibrary pypi;
/**
* URI of the requirements.txt file to install. Only Workspace paths and Unity Catalog Volumes
* paths are supported. For example: `{ "requirements": "/Workspace/path/to/requirements.txt" }`
- * or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`
+ * or `{ "requirements" : "/Volumes/path/to/requirements.txt" }`. Installing a requirements file
+ * requires Databricks Runtime 15.0 or above.
*/
@JsonProperty("requirements")
private String requirements;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibraryFullStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibraryFullStatus.java
index 8a4a0b6c0..cccae4f4b 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibraryFullStatus.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LibraryFullStatus.java
@@ -15,7 +15,7 @@ public class LibraryFullStatus {
@JsonProperty("is_library_for_all_clusters")
private Boolean isLibraryForAllClusters;
- /** Unique identifier for the library. */
+ /** The library whose status is reported. */
@JsonProperty("library")
private Library library;
@@ -23,7 +23,13 @@ public class LibraryFullStatus {
@JsonProperty("messages")
private Collection messages;
- /** Status of installing the library on the cluster. */
+ /**
+ * Status of installing the library on the cluster. The status starts at PENDING and ends at
+ * INSTALLED, FAILED or SKIPPED. Intermediate states are not always reported. A library stays
+ * UNINSTALL_ON_RESTART after an uninstall request until the cluster restarts. While the cluster
+ * is not running, libraries are reported as PENDING, and libraries marked for uninstall are
+ * omitted.
+ */
@JsonProperty("status")
private LibraryInstallStatus status;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogAnalyticsInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogAnalyticsInfo.java
index af2e30072..79333878f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogAnalyticsInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/LogAnalyticsInfo.java
@@ -9,11 +9,17 @@
@Generated
public class LogAnalyticsInfo {
- /** */
+ /**
+ * Primary key of the Azure Log Analytics workspace. The agent uses it to authenticate when
+ * reporting to the workspace.
+ */
@JsonProperty("log_analytics_primary_key")
private String logAnalyticsPrimaryKey;
- /** */
+ /**
+ * ID of the Azure Log Analytics workspace that the Log Analytics agent on the cluster's nodes
+ * reports to.
+ */
@JsonProperty("log_analytics_workspace_id")
private String logAnalyticsWorkspaceId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java
index a33b0e227..2f403d4d0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/MavenLibrary.java
@@ -15,7 +15,7 @@ public class MavenLibrary {
private String coordinates;
/**
- * List of dependences to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`.
+ * List of dependencies to exclude. For example: `["slf4j:slf4j", "*:hadoop-client"]`.
*
* Maven dependency exclusions:
* https://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PythonPyPiLibrary.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PythonPyPiLibrary.java
index c5896f10d..30d785cc6 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PythonPyPiLibrary.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/PythonPyPiLibrary.java
@@ -10,7 +10,7 @@
@Generated
public class PythonPyPiLibrary {
/**
- * The name of the pypi package to install. An optional exact version specification is also
+ * The name of the PyPI package to install. An optional exact version specification is also
* supported. Examples: "simplejson" and "simplejson==3.8.0".
*/
@JsonProperty("package")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/RestartCluster.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/RestartCluster.java
index ee78f3391..4667323a1 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/RestartCluster.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/RestartCluster.java
@@ -13,7 +13,10 @@ public class RestartCluster {
@JsonProperty("cluster_id")
private String clusterId;
- /** */
+ /**
+ * User name recorded in the `RESTARTING` cluster event as the user who restarted the cluster. If
+ * omitted, the name of the user making the request is recorded.
+ */
@JsonProperty("restart_user")
private String restartUser;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java
index 3f8d5b5b5..06efdc67e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/UpdateClusterResource.java
@@ -71,7 +71,34 @@ public class UpdateClusterResource {
@JsonProperty("custom_tags")
private Map customTags;
- /** */
+ /**
+ * Data security mode decides what data governance model to use when accessing data from a
+ * cluster.
+ *
+ * * `DATA_SECURITY_MODE_AUTO`: Databricks will choose the most appropriate access mode
+ * depending on your compute configuration. * `DATA_SECURITY_MODE_STANDARD`: A secure cluster that
+ * can be shared by multiple users. Cluster users are fully isolated so that they cannot see each
+ * other's data and credentials. Most data governance features are supported in this mode. But
+ * programming languages and cluster features might be limited. * `DATA_SECURITY_MODE_DEDICATED`:
+ * A secure cluster that can only be exclusively used by a single user specified in
+ * `single_user_name`. Most programming languages, cluster features and data governance features
+ * are available in this mode. * `NONE`: No security isolation for multiple users sharing the
+ * cluster. Data governance features are not available in this mode.
+ *
+ *
The following modes are legacy aliases for the above modes:
+ *
+ *
* `USER_ISOLATION`: Legacy alias for `DATA_SECURITY_MODE_STANDARD`. * `SINGLE_USER`: Legacy
+ * alias for `DATA_SECURITY_MODE_DEDICATED`.
+ *
+ *
The following modes are deprecated starting with Databricks Runtime 15.0 and will be removed
+ * for future Databricks Runtime versions:
+ *
+ *
* `LEGACY_TABLE_ACL`: This mode is for users migrating from legacy Table ACL clusters. *
+ * `LEGACY_PASSTHROUGH`: This mode is for users migrating from legacy Passthrough on high
+ * concurrency clusters. * `LEGACY_SINGLE_USER`: This mode is for users migrating from legacy
+ * Passthrough on standard clusters. * `LEGACY_SINGLE_USER_STANDARD`: This mode provides a way
+ * that doesn't have UC or passthrough enabled.
+ */
@JsonProperty("data_security_mode")
private DataSecurityMode dataSecurityMode;
@@ -79,7 +106,11 @@ public class UpdateClusterResource {
@JsonProperty("dependency_mode")
private DependencyMode dependencyMode;
- /** Custom docker image BYOC */
+ /**
+ * Custom Docker image for the cluster's nodes, used with [Databricks Container Services].
+ *
+ *
[Databricks Container Services]: https://docs.databricks.com/compute/custom-containers.html
+ */
@JsonProperty("docker_image")
private DockerImage dockerImage;
@@ -140,7 +171,20 @@ public class UpdateClusterResource {
@JsonProperty("is_single_node")
private Boolean isSingleNode;
- /** */
+ /**
+ * The kind of compute described by this compute specification.
+ *
+ *
Depending on `kind`, different validations and default values will be applied.
+ *
+ *
Clusters with `kind = CLASSIC_PREVIEW` support the following fields, whereas clusters with
+ * no specified `kind` do not. * [is_single_node] * [use_ml_runtime]
+ *
+ *
By using the [simple form], your clusters are automatically using `kind = CLASSIC_PREVIEW`.
+ *
+ *
[is_single_node]: https://docs.databricks.com/api/workspace/clusters/create#is_single_node
+ * [simple form]: https://docs.databricks.com/compute/simple-form.html [use_ml_runtime]:
+ * https://docs.databricks.com/api/workspace/clusters/create#use_ml_runtime
+ */
@JsonProperty("kind")
private Kind kind;
@@ -256,7 +300,10 @@ public class UpdateClusterResource {
@JsonProperty("worker_node_type_flexibility")
private NodeTypeFlexibility workerNodeTypeFlexibility;
- /** */
+ /**
+ * Types of workloads that can use the cluster, such as notebooks or jobs. If omitted, the cluster
+ * can be used for both notebooks and jobs.
+ */
@JsonProperty("workload_type")
private WorkloadType workloadType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetails.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetails.java
index a3d94b322..2016623ae 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetails.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetails.java
@@ -12,25 +12,26 @@
public class AuthorizationDetails {
/**
* Represents downscoped permission rules with specific access rights. This field is specific to
- * `workspace_rule_set` constraint.
+ * the `workspace_rule_set` constraint.
*/
@JsonProperty("grant_rules")
private Collection grantRules;
- /** The acl path of the tree store resource resource. */
+ /** The legacy ACL path of the workspace object that the rule applies to. */
@JsonProperty("resource_legacy_acl_path")
private String resourceLegacyAclPath;
/**
- * The resource name to which the authorization rule applies. This field is specific to
- * `workspace_rule_set` constraint. Format: `workspaces/{workspace_id}/dashboards/{dashboard_id}`
+ * The resource name to which the authorization rule applies. This field is specific to the
+ * `workspace_rule_set` constraint. Format: `workspaces/{workspace_id}` for a workspace-level
+ * rule, or `workspaces/{workspace_id}/dashboards/{dashboard_id}` for a rule on a dashboard.
*/
@JsonProperty("resource_name")
private String resourceName;
/**
- * The type of authorization downscoping policy. Ex: `workspace_rule_set` defines access rules for
- * a specific workspace resource
+ * The type of authorization downscoping policy. A `workspace_rule_set` policy defines access
+ * rules for a specific workspace resource.
*/
@JsonProperty("type")
private String typeValue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetailsGrantRule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetailsGrantRule.java
index ab39e1f8b..6014d1271 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetailsGrantRule.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/AuthorizationDetailsGrantRule.java
@@ -9,11 +9,7 @@
@Generated
public class AuthorizationDetailsGrantRule {
- /**
- * Permission sets for dashboard are defined in
- * iam-common/rbac-common/permission-sets/definitions/TreeStoreBasePermissionSets Ex:
- * `permissionSets/dashboard.runner`
- */
+ /** The permission set that the rule grants on the resource. */
@JsonProperty("permission_set")
private String permissionSet;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/CronSchedule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/CronSchedule.java
index db2332001..a08336711 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/CronSchedule.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/CronSchedule.java
@@ -10,11 +10,11 @@
@Generated
public class CronSchedule {
/**
- * A cron expression using quartz syntax. EX: `0 0 8 * * ?` represents everyday at 8am. See [Cron
- * Trigger] for details.
+ * A cron expression in Quartz syntax that defines when the schedule runs. See the [Quartz cron
+ * trigger tutorial] for the syntax.
*
- * [Cron Trigger]:
- * http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
+ *
[Quartz cron trigger tutorial]:
+ * https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html
*/
@JsonProperty("quartz_cron_expression")
private String quartzCronExpression;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/DeleteSubscriptionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/DeleteSubscriptionRequest.java
index 0dc9d9199..e364e176e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/DeleteSubscriptionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/DeleteSubscriptionRequest.java
@@ -10,18 +10,18 @@
@Generated
public class DeleteSubscriptionRequest {
- /** UUID identifying the dashboard which the subscription belongs. */
+ /** UUID identifying the dashboard to which the subscription belongs. */
@JsonIgnore private String dashboardId;
/**
- * The etag for the subscription. Can be optionally provided to ensure that the subscription has
- * not been modified since the last read.
+ * The etag of the subscription, as returned when it was read. If it is provided and no longer
+ * matches, the request fails with ABORTED and the subscription is not deleted.
*/
@JsonIgnore
@QueryParam("etag")
private String etag;
- /** UUID identifying the schedule which the subscription belongs. */
+ /** UUID identifying the schedule to which the subscription belongs. */
@JsonIgnore private String scheduleId;
/** UUID identifying the subscription. */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoRequest.java
index 37a2db41f..92fa65f1c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoRequest.java
@@ -13,12 +13,19 @@ public class GetPublishedDashboardTokenInfoRequest {
/** UUID identifying the published dashboard. */
@JsonIgnore private String dashboardId;
- /** Provided external value to be included in the custom claim. */
+ /**
+ * Value to carry in the token for this viewer, such as a tenant or region key. Dashboard dataset
+ * queries can reference it as `__aibi_external_value` to filter data per viewer. The combined
+ * size of `external_value` and `external_viewer_id` must be less than 1 KB.
+ */
@JsonIgnore
@QueryParam("external_value")
private String externalValue;
- /** Provided external viewer id to be included in the custom claim. */
+ /**
+ * Identifier of the viewer in the external application. It is recorded in dashboard audit logs,
+ * so it should be unique per viewer and must not contain personally identifiable information.
+ */
@JsonIgnore
@QueryParam("external_viewer_id")
private String externalViewerId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoResponse.java
index e7022d311..768765d99 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetPublishedDashboardTokenInfoResponse.java
@@ -11,21 +11,21 @@
@Generated
public class GetPublishedDashboardTokenInfoResponse {
/**
- * Authorization constraints for accessing the published dashboard. Currently includes
- * `workspace_rule_set` and could be enriched with `unity_catalog_privileges` before oAuth token
- * generation.
+ * Authorization constraints that restrict the minted token to viewing the published dashboard.
+ * Pass them to the OAuth token endpoint serialized as a JSON array.
*/
@JsonProperty("authorization_details")
private Collection authorizationDetails;
/**
- * Custom claim generated from external_value and external_viewer_id. Format:
+ * Custom claim that carries `external_value` and `external_viewer_id` into the minted token. It
+ * is only present when at least one of those query parameters was provided. Format:
* `urn:aibi:external_data:::`
*/
@JsonProperty("custom_claim")
private String customClaim;
- /** Scope defining access permissions. */
+ /** The space-separated OAuth scopes to request when minting the token. */
@JsonProperty("scope")
private String scope;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetSubscriptionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetSubscriptionRequest.java
index f924e63f4..ac3cccd07 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetSubscriptionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/GetSubscriptionRequest.java
@@ -9,10 +9,10 @@
@Generated
public class GetSubscriptionRequest {
- /** UUID identifying the dashboard which the subscription belongs. */
+ /** UUID identifying the dashboard to which the subscription belongs. */
@JsonIgnore private String dashboardId;
- /** UUID identifying the schedule which the subscription belongs. */
+ /** UUID identifying the schedule to which the subscription belongs. */
@JsonIgnore private String scheduleId;
/** UUID identifying the subscription. */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java
index 5ad2b97dc..cb1c04e99 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewAPI.java
@@ -33,7 +33,8 @@ public Dashboard create(CreateDashboardRequest request) {
}
/**
- * Create dashboard schedule.
+ * Creates a schedule for a dashboard. The dashboard must be published before a schedule can be
+ * created for it.
*
* Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to
* Workspace access.
@@ -45,7 +46,12 @@ public Schedule createSchedule(CreateScheduleRequest request) {
}
/**
- * Create schedule subscription.
+ * Create schedule subscription. Subscribes a workspace user or a notification destination to the
+ * schedule, so that it receives a snapshot of the dashboard each time the schedule runs.
+ * Subscribing yourself requires CAN VIEW permission on the dashboard; subscribing another user or
+ * a notification destination requires CAN EDIT. On dashboards published without embedded
+ * credentials, you can only subscribe yourself. If the subscriber is already subscribed to the
+ * schedule, the existing subscription is returned.
*
*
The caller must be a workspace user with one of the following [entitlements]: Workspace
* access, Databricks SQL access, or Consumer access.
@@ -65,7 +71,7 @@ public void deleteSchedule(String dashboardId, String scheduleId) {
}
/**
- * Delete dashboard schedule.
+ * Deletes a schedule together with all of its subscriptions.
*
*
Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to
* Workspace access.
@@ -85,7 +91,9 @@ public void deleteSubscription(String dashboardId, String scheduleId, String sub
}
/**
- * Delete schedule subscription.
+ * Delete schedule subscription. The subscriber receives no further snapshots from the schedule.
+ * Deleting your own subscription requires CAN VIEW permission on the dashboard; deleting another
+ * user's or a notification destination's subscription requires CAN EDIT.
*
*
The caller must be a workspace user with one of the following [entitlements]: Workspace
* access, Databricks SQL access, or Consumer access.
@@ -113,7 +121,8 @@ public PublishedDashboard getPublished(String dashboardId) {
}
/**
- * Get the current published dashboard.
+ * Get the current published dashboard. The request fails with NOT_FOUND if the dashboard has
+ * never been published or has been unpublished.
*
*
The caller must be a workspace user with one of the following entitlements: Workspace
* access, Databricks SQL access, or Consumer access.
@@ -259,7 +268,12 @@ public PublishedDashboard publish(PublishRequest request) {
return impl.publish(request);
}
- /** Revert a dashboard's definition in draft mode to the last published version. */
+ /**
+ * Revert a dashboard's definition in draft mode to the last published version. The draft's
+ * datasets, pages and widgets are replaced with those of the current published version, and the
+ * updated draft is returned. The dashboard must have been published at least once; the published
+ * version itself is not changed.
+ */
public RevertDashboardResponse revert(RevertDashboardRequest request) {
return impl.revert(request);
}
@@ -277,7 +291,11 @@ public void unpublish(String dashboardId) {
unpublish(new UnpublishDashboardRequest().setDashboardId(dashboardId));
}
- /** Unpublish the dashboard. */
+ /**
+ * Unpublish the dashboard. This deletes the published version, so viewers can no longer open it,
+ * and pauses the dashboard's schedules. The draft is not changed; publish it again to make the
+ * dashboard available to viewers.
+ */
public void unpublish(UnpublishDashboardRequest request) {
impl.unpublish(request);
}
@@ -288,7 +306,8 @@ public Dashboard update(UpdateDashboardRequest request) {
}
/**
- * Update dashboard schedule.
+ * Updates a schedule. The request body replaces the stored schedule, so fields omitted from the
+ * body are reset to their defaults.
*
*
Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to
* Workspace access.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedAPI.java
index f3362b7ad..cb3a3483c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedAPI.java
@@ -29,14 +29,20 @@ public GetPublishedDashboardTokenInfoResponse getPublishedDashboardTokenInfo(Str
}
/**
- * Get a required authorization details and scopes of a published dashboard to mint an OAuth
- * token.
+ * Get the OAuth scope and authorization details needed to mint a token that is scoped to viewing
+ * the published dashboard, for example to embed it in an external application. Pass the response
+ * fields, with `authorization_details` serialized as a JSON string, to the workspace OAuth token
+ * endpoint with the `client_credentials` grant to mint the token. See [Embedding for external
+ * users].
*
*
The caller must be a workspace user with one of the following entitlements: Workspace
* access, Databricks SQL access, or Consumer access.
*
*
Account-level users who are not members of the workspace cannot call this endpoint, even if
* the dashboard has been shared with them.
+ *
+ *
[Embedding for external users]:
+ * https://docs.databricks.com/dashboards/share/embedding/external-embed
*/
public GetPublishedDashboardTokenInfoResponse getPublishedDashboardTokenInfo(
GetPublishedDashboardTokenInfoRequest request) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedService.java
index fe6618e21..4a4965f38 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewEmbeddedService.java
@@ -13,14 +13,20 @@
@Generated
public interface LakeviewEmbeddedService {
/**
- * Get a required authorization details and scopes of a published dashboard to mint an OAuth
- * token.
+ * Get the OAuth scope and authorization details needed to mint a token that is scoped to viewing
+ * the published dashboard, for example to embed it in an external application. Pass the response
+ * fields, with `authorization_details` serialized as a JSON string, to the workspace OAuth token
+ * endpoint with the `client_credentials` grant to mint the token. See [Embedding for external
+ * users].
*
*
The caller must be a workspace user with one of the following entitlements: Workspace
* access, Databricks SQL access, or Consumer access.
*
*
Account-level users who are not members of the workspace cannot call this endpoint, even if
* the dashboard has been shared with them.
+ *
+ *
[Embedding for external users]:
+ * https://docs.databricks.com/dashboards/share/embedding/external-embed
*/
GetPublishedDashboardTokenInfoResponse getPublishedDashboardTokenInfo(
GetPublishedDashboardTokenInfoRequest getPublishedDashboardTokenInfoRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java
index 019e2265f..ab74d7737 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/LakeviewService.java
@@ -17,7 +17,8 @@ public interface LakeviewService {
Dashboard create(CreateDashboardRequest createDashboardRequest);
/**
- * Create dashboard schedule.
+ * Creates a schedule for a dashboard. The dashboard must be published before a schedule can be
+ * created for it.
*
*
Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to
* Workspace access.
@@ -27,7 +28,12 @@ public interface LakeviewService {
Schedule createSchedule(CreateScheduleRequest createScheduleRequest);
/**
- * Create schedule subscription.
+ * Create schedule subscription. Subscribes a workspace user or a notification destination to the
+ * schedule, so that it receives a snapshot of the dashboard each time the schedule runs.
+ * Subscribing yourself requires CAN VIEW permission on the dashboard; subscribing another user or
+ * a notification destination requires CAN EDIT. On dashboards published without embedded
+ * credentials, you can only subscribe yourself. If the subscriber is already subscribed to the
+ * schedule, the existing subscription is returned.
*
*
The caller must be a workspace user with one of the following [entitlements]: Workspace
* access, Databricks SQL access, or Consumer access.
@@ -40,7 +46,7 @@ public interface LakeviewService {
Subscription createSubscription(CreateSubscriptionRequest createSubscriptionRequest);
/**
- * Delete dashboard schedule.
+ * Deletes a schedule together with all of its subscriptions.
*
*
Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to
* Workspace access.
@@ -50,7 +56,9 @@ public interface LakeviewService {
void deleteSchedule(DeleteScheduleRequest deleteScheduleRequest);
/**
- * Delete schedule subscription.
+ * Delete schedule subscription. The subscriber receives no further snapshots from the schedule.
+ * Deleting your own subscription requires CAN VIEW permission on the dashboard; deleting another
+ * user's or a notification destination's subscription requires CAN EDIT.
*
*
The caller must be a workspace user with one of the following [entitlements]: Workspace
* access, Databricks SQL access, or Consumer access.
@@ -66,7 +74,8 @@ public interface LakeviewService {
Dashboard get(GetDashboardRequest getDashboardRequest);
/**
- * Get the current published dashboard.
+ * Get the current published dashboard. The request fails with NOT_FOUND if the dashboard has
+ * never been published or has been unpublished.
*
*
The caller must be a workspace user with one of the following entitlements: Workspace
* access, Databricks SQL access, or Consumer access.
@@ -143,20 +152,30 @@ public interface LakeviewService {
/** Publish the current draft dashboard. */
PublishedDashboard publish(PublishRequest publishRequest);
- /** Revert a dashboard's definition in draft mode to the last published version. */
+ /**
+ * Revert a dashboard's definition in draft mode to the last published version. The draft's
+ * datasets, pages and widgets are replaced with those of the current published version, and the
+ * updated draft is returned. The dashboard must have been published at least once; the published
+ * version itself is not changed.
+ */
RevertDashboardResponse revert(RevertDashboardRequest revertDashboardRequest);
/** Trash a dashboard. */
void trash(TrashDashboardRequest trashDashboardRequest);
- /** Unpublish the dashboard. */
+ /**
+ * Unpublish the dashboard. This deletes the published version, so viewers can no longer open it,
+ * and pauses the dashboard's schedules. The draft is not changed; publish it again to make the
+ * dashboard available to viewers.
+ */
void unpublish(UnpublishDashboardRequest unpublishDashboardRequest);
/** Update a draft dashboard. */
Dashboard update(UpdateDashboardRequest updateDashboardRequest);
/**
- * Update dashboard schedule.
+ * Updates a schedule. The request body replaces the stored schedule, so fields omitted from the
+ * body are reset to their defaults.
*
*
Requires the [Databricks SQL access] entitlement. Grant Databricks SQL access in addition to
* Workspace access.
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSchedulesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSchedulesRequest.java
index 5382151b8..b14db184f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSchedulesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSchedulesRequest.java
@@ -10,7 +10,7 @@
@Generated
public class ListSchedulesRequest {
- /** UUID identifying the dashboard to which the schedules belongs. */
+ /** UUID identifying the dashboard to which the schedules belong. */
@JsonIgnore private String dashboardId;
/** The number of schedules to return per page. */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSubscriptionsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSubscriptionsRequest.java
index d38d1dc36..2ceeebdcb 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSubscriptionsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/ListSubscriptionsRequest.java
@@ -10,7 +10,7 @@
@Generated
public class ListSubscriptionsRequest {
- /** UUID identifying the dashboard which the subscriptions belongs. */
+ /** UUID identifying the dashboard to which the subscriptions belong. */
@JsonIgnore private String dashboardId;
/** The number of subscriptions to return per page. */
@@ -26,7 +26,7 @@ public class ListSubscriptionsRequest {
@QueryParam("page_token")
private String pageToken;
- /** UUID identifying the schedule which the subscriptions belongs. */
+ /** UUID identifying the schedule to which the subscriptions belong. */
@JsonIgnore private String scheduleId;
public ListSubscriptionsRequest setDashboardId(String dashboardId) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/PublishedDashboard.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/PublishedDashboard.java
index c8133c4f2..8e8538148 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/PublishedDashboard.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/PublishedDashboard.java
@@ -13,15 +13,25 @@ public class PublishedDashboard {
@JsonProperty("display_name")
private String displayName;
- /** Indicates whether credentials are embedded in the published dashboard. */
+ /**
+ * Whether the publisher's credentials are embedded in the published dashboard. When true, viewers
+ * run the dashboard's queries with the publisher's data permissions (shared data permissions);
+ * when false, each viewer runs them with their own data permissions.
+ */
@JsonProperty("embed_credentials")
private Boolean embedCredentials;
- /** The timestamp of when the published dashboard was last revised. */
+ /**
+ * The timestamp of when the current published version was created, that is, when the dashboard
+ * was last published.
+ */
@JsonProperty("revision_create_time")
private String revisionCreateTime;
- /** The warehouse ID used to run the published dashboard. */
+ /**
+ * The ID of the SQL warehouse that runs the published dashboard's queries. It is the warehouse
+ * given when the dashboard was published, or the draft's warehouse if none was given.
+ */
@JsonProperty("warehouse_id")
private String warehouseId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/RevertDashboardRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/RevertDashboardRequest.java
index f9cfe3701..b487b2545 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/RevertDashboardRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/RevertDashboardRequest.java
@@ -15,8 +15,8 @@ public class RevertDashboardRequest {
@JsonIgnore private String dashboardId;
/**
- * The etag for the dashboard. Optionally, it can be provided to verify that the dashboard has not
- * been modified from its last retrieval.
+ * The etag of the draft dashboard, as returned by the get dashboard API. When provided, the
+ * request fails with ABORTED if the draft has been modified since that etag was read.
*/
@JsonProperty("etag")
private String etag;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Schedule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Schedule.java
index 0cf82ee0d..233b34356 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Schedule.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Schedule.java
@@ -7,13 +7,21 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * A schedule periodically runs a dashboard on a cron cadence. Each run executes the dashboard's
+ * queries to refresh its cached data and sends a snapshot of the dashboard to the schedule's
+ * subscribers. See [Manage scheduled dashboard updates and subscriptions] for details.
+ *
+ *
[Manage scheduled dashboard updates and subscriptions]:
+ * https://docs.databricks.com/dashboards/share/schedule-subscribe
+ */
@Generated
public class Schedule {
/** A timestamp indicating when the schedule was created. */
@JsonProperty("create_time")
private String createTime;
- /** The cron expression describing the frequency of the periodic refresh for this schedule. */
+ /** The cron expression and time zone that define when the schedule runs. */
@JsonProperty("cron_schedule")
private CronSchedule cronSchedule;
@@ -21,7 +29,7 @@ public class Schedule {
@JsonProperty("dashboard_id")
private String dashboardId;
- /** The display name for schedule. */
+ /** The name of the schedule, as shown in the dashboard's list of schedules. */
@JsonProperty("display_name")
private String displayName;
@@ -33,7 +41,10 @@ public class Schedule {
@JsonProperty("etag")
private String etag;
- /** The status indicates whether this schedule is paused or not. */
+ /**
+ * Whether the schedule is paused. A paused schedule keeps its configuration and subscribers, but
+ * the dashboard is not refreshed and no notifications are sent until the schedule is unpaused.
+ */
@JsonProperty("pause_status")
private SchedulePauseStatus pauseStatus;
@@ -45,7 +56,10 @@ public class Schedule {
@JsonProperty("update_time")
private String updateTime;
- /** The warehouse id to run the dashboard with for the schedule. */
+ /**
+ * The ID of the SQL warehouse that runs the dashboard's queries during scheduled refreshes. If
+ * omitted, the warehouse of the published dashboard is used.
+ */
@JsonProperty("warehouse_id")
private String warehouseId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscriber.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscriber.java
index b1677565e..046fdf289 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscriber.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscriber.java
@@ -10,16 +10,13 @@
@Generated
public class Subscriber {
/**
- * The destination to receive the subscription email. This parameter is mutually exclusive with
- * `user_subscriber`.
+ * The notification destination that receives the subscription, such as an email list or a Slack
+ * or Microsoft Teams channel. Workspace admins configure notification destinations.
*/
@JsonProperty("destination_subscriber")
private SubscriptionSubscriberDestination destinationSubscriber;
- /**
- * The user to receive the subscription email. This parameter is mutually exclusive with
- * `destination_subscriber`.
- */
+ /** The workspace user who receives the subscription. */
@JsonProperty("user_subscriber")
private SubscriptionSubscriberUser userSubscriber;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscription.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscription.java
index 3a8978fcc..1f4247283 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscription.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/Subscription.java
@@ -7,6 +7,15 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * A subscription registers a workspace user or a notification destination as a subscriber of a
+ * dashboard schedule. Each time the schedule runs, the subscriber receives a snapshot of the
+ * published dashboard, unless the subscription is refresh-only. See [Manage scheduled dashboard
+ * updates and subscriptions].
+ *
+ *
[Manage scheduled dashboard updates and subscriptions]:
+ * https://docs.databricks.com/dashboards/share/schedule-subscribe
+ */
@Generated
public class Subscription {
/** A timestamp indicating when the subscription was created. */
@@ -25,8 +34,8 @@ public class Subscription {
private String dashboardId;
/**
- * The etag for the subscription. Must be left empty on create, can be optionally provided on
- * delete to ensure that the subscription has not been deleted since the last read.
+ * The etag of the subscription. It must be left empty on create. It can be passed as the `etag`
+ * parameter of the delete method to make sure the subscription has not changed since it was read.
*/
@JsonProperty("etag")
private String etag;
@@ -36,14 +45,17 @@ public class Subscription {
private String scheduleId;
/**
- * Controls whether notifications are sent to the subscriber for scheduled dashboard refreshes. If
- * not defined, defaults to false in the backend to match the current behavior (refresh and
- * notify)
+ * Whether the subscription is refresh-only. When true, each scheduled run refreshes the dashboard
+ * data for the subscriber without sending a notification. Defaults to false. Refresh-only
+ * subscriptions are only allowed on dashboards published without embedded credentials.
*/
@JsonProperty("skip_notify")
private Boolean skipNotify;
- /** Subscriber details for users and destinations to be added as subscribers to the schedule. */
+ /**
+ * The subscriber that receives the dashboard snapshot. Exactly one of `user_subscriber` and
+ * `destination_subscriber` must be set.
+ */
@JsonProperty("subscriber")
private Subscriber subscriber;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberDestination.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberDestination.java
index cfdbdda70..d60f2b7e2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberDestination.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberDestination.java
@@ -9,7 +9,13 @@
@Generated
public class SubscriptionSubscriberDestination {
- /** The canonical identifier of the destination to receive email notification. */
+ /**
+ * The UUID of the notification destination that receives the subscription, as returned by the
+ * [Notification Destinations API].
+ *
+ *
[Notification Destinations API]:
+ * https://docs.databricks.com/api/workspace/notificationdestinations
+ */
@JsonProperty("destination_id")
private String destinationId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberUser.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberUser.java
index 0338eac01..4b80e065a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberUser.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/dashboards/SubscriptionSubscriberUser.java
@@ -9,7 +9,12 @@
@Generated
public class SubscriptionSubscriberUser {
- /** UserId of the subscriber. */
+ /**
+ * The ID of the workspace user who receives the subscription, as returned by the [Workspace Users
+ * API].
+ *
+ *
[Workspace Users API]: https://docs.databricks.com/api/workspace/users
+ */
@JsonProperty("user_id")
private Long userId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryAPI.java
index 553be654a..889cbbda7 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryAPI.java
@@ -24,7 +24,12 @@ public DisasterRecoveryAPI(DisasterRecoveryService mock) {
impl = mock;
}
- /** Create a new failover group. */
+ /**
+ * Create a failover group. The group starts in the CREATING state and moves to
+ * INITIAL_REPLICATION while the first replication cycle copies all in-scope data to the secondary
+ * region; failover becomes available once the group is ACTIVE. Set validate_only to check the
+ * request without creating anything.
+ */
public FailoverGroup createFailoverGroup(CreateFailoverGroupRequest request) {
return impl.createFailoverGroup(request);
}
@@ -38,7 +43,10 @@ public void deleteFailoverGroup(String name) {
deleteFailoverGroup(new DeleteFailoverGroupRequest().setName(name));
}
- /** Delete a failover group. */
+ /**
+ * Delete a failover group. Deleting stops replication for the group; stable URLs linked to it are
+ * detached but not deleted.
+ */
public void deleteFailoverGroup(DeleteFailoverGroupRequest request) {
impl.deleteFailoverGroup(request);
}
@@ -52,7 +60,15 @@ public void deleteStableUrl(DeleteStableUrlRequest request) {
impl.deleteStableUrl(request);
}
- /** Initiate a failover to a new primary region. */
+ /**
+ * Initiate a failover that makes target_primary_region the primary region. Stable URLs linked to
+ * the group are pointed at the new primary workspace, replication is reversed so that the former
+ * primary becomes the secondary, and the group moves through FAILING_OVER to INITIAL_REPLICATION
+ * until it has a replication point in the new direction. The group must be ACTIVE; repeating the
+ * request while it is FAILING_OVER is accepted. To fail back, repeat the request with the former
+ * primary region as the target once the group is ACTIVE again. In an unplanned failover, data
+ * written after the replication point can be lost.
+ */
public FailoverGroup failoverFailoverGroup(FailoverFailoverGroupRequest request) {
return impl.failoverFailoverGroup(request);
}
@@ -61,7 +77,7 @@ public FailoverGroup getFailoverGroup(String name) {
return getFailoverGroup(new GetFailoverGroupRequest().setName(name));
}
- /** Get a failover group. */
+ /** Get a failover group, including its current state and replication point. */
public FailoverGroup getFailoverGroup(GetFailoverGroupRequest request) {
return impl.getFailoverGroup(request);
}
@@ -80,10 +96,11 @@ public Iterable listFailoverGroups(String parent) {
}
/**
- * List failover groups.
+ * List the failover groups in an account.
*
- * List entries are abbreviated: `state` and `replication_point` are not populated. Call
- * GetFailoverGroup to retrieve the full resource.
+ *
List entries are abbreviated: `state`, `replication_point` and
+ * `unity_catalog_assets.location_mappings` are not populated. Call GetFailoverGroup to retrieve
+ * the full resource.
*/
public Iterable listFailoverGroups(ListFailoverGroupsRequest request) {
return Paginator.newTokenPagination(
@@ -118,7 +135,13 @@ public Iterable listStableUrls(ListStableUrlsRequest request) {
});
}
- /** Update a failover group. */
+ /**
+ * Update a failover group. Only the fields named in update_mask change. You can turn workspace
+ * asset replication on or off, attach or detach a stable URL, and change the Unity Catalog
+ * catalogs and location mappings; the regions, the workspace set name and the workspace IDs
+ * cannot be changed. Updates are rejected while a create, failover or delete is in progress, and
+ * after a create or delete has failed.
+ */
public FailoverGroup updateFailoverGroup(UpdateFailoverGroupRequest request) {
return impl.updateFailoverGroup(request);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryService.java
index b59ee3e3a..3161820df 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/DisasterRecoveryService.java
@@ -12,32 +12,49 @@
*/
@Generated
public interface DisasterRecoveryService {
- /** Create a new failover group. */
+ /**
+ * Create a failover group. The group starts in the CREATING state and moves to
+ * INITIAL_REPLICATION while the first replication cycle copies all in-scope data to the secondary
+ * region; failover becomes available once the group is ACTIVE. Set validate_only to check the
+ * request without creating anything.
+ */
FailoverGroup createFailoverGroup(CreateFailoverGroupRequest createFailoverGroupRequest);
/** Create a new stable URL. */
StableUrl createStableUrl(CreateStableUrlRequest createStableUrlRequest);
- /** Delete a failover group. */
+ /**
+ * Delete a failover group. Deleting stops replication for the group; stable URLs linked to it are
+ * detached but not deleted.
+ */
void deleteFailoverGroup(DeleteFailoverGroupRequest deleteFailoverGroupRequest);
/** Delete a stable URL. */
void deleteStableUrl(DeleteStableUrlRequest deleteStableUrlRequest);
- /** Initiate a failover to a new primary region. */
+ /**
+ * Initiate a failover that makes target_primary_region the primary region. Stable URLs linked to
+ * the group are pointed at the new primary workspace, replication is reversed so that the former
+ * primary becomes the secondary, and the group moves through FAILING_OVER to INITIAL_REPLICATION
+ * until it has a replication point in the new direction. The group must be ACTIVE; repeating the
+ * request while it is FAILING_OVER is accepted. To fail back, repeat the request with the former
+ * primary region as the target once the group is ACTIVE again. In an unplanned failover, data
+ * written after the replication point can be lost.
+ */
FailoverGroup failoverFailoverGroup(FailoverFailoverGroupRequest failoverFailoverGroupRequest);
- /** Get a failover group. */
+ /** Get a failover group, including its current state and replication point. */
FailoverGroup getFailoverGroup(GetFailoverGroupRequest getFailoverGroupRequest);
/** Get a stable URL. */
StableUrl getStableUrl(GetStableUrlRequest getStableUrlRequest);
/**
- * List failover groups.
+ * List the failover groups in an account.
*
- * List entries are abbreviated: `state` and `replication_point` are not populated. Call
- * GetFailoverGroup to retrieve the full resource.
+ *
List entries are abbreviated: `state`, `replication_point` and
+ * `unity_catalog_assets.location_mappings` are not populated. Call GetFailoverGroup to retrieve
+ * the full resource.
*/
ListFailoverGroupsResponse listFailoverGroups(
ListFailoverGroupsRequest listFailoverGroupsRequest);
@@ -45,6 +62,12 @@ ListFailoverGroupsResponse listFailoverGroups(
/** List stable URLs for an account. */
ListStableUrlsResponse listStableUrls(ListStableUrlsRequest listStableUrlsRequest);
- /** Update a failover group. */
+ /**
+ * Update a failover group. Only the fields named in update_mask change. You can turn workspace
+ * asset replication on or off, attach or detach a stable URL, and change the Unity Catalog
+ * catalogs and location mappings; the regions, the workspace set name and the workspace IDs
+ * cannot be changed. Updates are rejected while a create, failover or delete is in progress, and
+ * after a create or delete has failed.
+ */
FailoverGroup updateFailoverGroup(UpdateFailoverGroupRequest updateFailoverGroupRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverFailoverGroupRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverFailoverGroupRequest.java
index ba2d72885..e88264f94 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverFailoverGroupRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverFailoverGroupRequest.java
@@ -18,7 +18,7 @@ public class FailoverFailoverGroupRequest {
@JsonProperty("etag")
private String etag;
- /** The type of failover to perform. */
+ /** The type of failover to perform. FORCED is the only supported type. */
@JsonProperty("failover_type")
private FailoverFailoverGroupRequestFailoverType failoverType;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverGroup.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverGroup.java
index e123b62f8..aeb42fb9c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverGroup.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/FailoverGroup.java
@@ -10,8 +10,11 @@
import java.util.Objects;
/**
- * A failover group manages disaster recovery across workspace sets, coordinating Unity Catalog and
- * workspace assets replication.
+ * A failover group manages Databricks Managed Disaster Recovery for a pair of workspaces in two
+ * regions. It continuously replicates the selected Unity Catalog catalogs and workspace assets from
+ * the primary region to the secondary region and lets you fail over to the secondary region; at
+ * least one of the two replication types must be enabled. See
+ * https://docs.databricks.com/aws/en/admin/managed-disaster-recovery for the product documentation.
*/
@Generated
public class FailoverGroup {
@@ -30,13 +33,17 @@ public class FailoverGroup {
@JsonProperty("etag")
private String etag;
- /** True if errors currently block the replication point. */
+ /**
+ * True when replication errors are preventing the replication point from advancing. Populated
+ * only while the failover group is INITIAL_REPLICATION or ACTIVE; the blocking errors are listed
+ * in the system.replication.states system table.
+ */
@JsonProperty("has_replication_point_blocking_errors")
private Boolean hasReplicationPointBlockingErrors;
/**
- * Initial primary region. Used only in Create requests to set the starting primary region. Not
- * returned in responses.
+ * Initial primary region. Used only in Create requests to set the starting primary region, and
+ * must be one of the regions in `regions`. Not returned in responses.
*/
@JsonProperty("initial_primary_region")
private String initialPrimaryRegion;
@@ -55,19 +62,37 @@ public class FailoverGroup {
@JsonProperty("name")
private String name;
- /** List of all regions participating in this failover group. */
+ /**
+ * The two cloud regions that participate in this failover group, the primary and the secondary.
+ * Each workspace set contains one workspace in each region.
+ */
@JsonProperty("regions")
private Collection regions;
- /** The latest point in time to which data has been replicated. */
+ /**
+ * The most recent point in time up to which all in-scope assets have been replicated to the
+ * secondary region. Data written after this point might not exist in the secondary yet and can be
+ * lost in an unplanned failover. When both Unity Catalog and workspace assets are replicated,
+ * this is the older of the two replication points. Not populated until the first replication
+ * point exists, and not populated in ListFailoverGroups responses.
+ */
@JsonProperty("replication_point")
private Timestamp replicationPoint;
- /** Aggregate state of the failover group. */
+ /**
+ * Aggregate state of the failover group across Unity Catalog and workspace asset replication. The
+ * group is INITIAL_REPLICATION until it has a replication point, ACTIVE while replication is in
+ * steady state and failover is available, and FAILING_OVER while a failover is in progress; the
+ * `*_FAILED` values mean that the last operation did not complete. Not populated in
+ * ListFailoverGroups responses.
+ */
@JsonProperty("state")
private FailoverGroupState state;
- /** Unity Catalog replication configuration. */
+ /**
+ * Unity Catalog replication configuration: the catalogs to replicate and the storage location
+ * mappings for their data. Omit it to replicate workspace assets only.
+ */
@JsonProperty("unity_catalog_assets")
private UcReplicationConfig unityCatalogAssets;
@@ -75,7 +100,10 @@ public class FailoverGroup {
@JsonProperty("update_time")
private Timestamp updateTime;
- /** Workspace sets, each containing workspaces that replicate to each other. */
+ /**
+ * Workspace sets, each containing workspaces that replicate to each other. A failover group
+ * currently supports exactly one workspace set.
+ */
@JsonProperty("workspace_sets")
private Collection workspaceSets;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/InitialReplicationProgress.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/InitialReplicationProgress.java
index 0d8ceefff..86f1586e0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/InitialReplicationProgress.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/InitialReplicationProgress.java
@@ -13,7 +13,10 @@
*/
@Generated
public class InitialReplicationProgress {
- /** Percent complete, 0-100. */
+ /**
+ * Percentage of in-scope assets replicated so far, from 0 to 100. Stays below 100 while errors
+ * block the first replication point.
+ */
@JsonProperty("completed")
private Long completed;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMapping.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMapping.java
index 03e2ff72d..dad102aba 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMapping.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMapping.java
@@ -14,11 +14,14 @@
*/
@Generated
public class LocationMapping {
- /** Resource name for this location. */
+ /** Identifier of this location mapping, unique within the failover group. */
@JsonProperty("name")
private String name;
- /** URI for each region. Each entry maps a region name to a storage URI. */
+ /**
+ * The storage URI of this location in each region, with exactly one entry per region of the
+ * failover group.
+ */
@JsonProperty("uri_by_region")
private Collection uriByRegion;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMappingEntry.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMappingEntry.java
index c83e93499..7a79bfd99 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMappingEntry.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/LocationMappingEntry.java
@@ -13,11 +13,14 @@
*/
@Generated
public class LocationMappingEntry {
- /** The region name. */
+ /** Cloud region this URI applies to. Must be one of the failover group's regions. */
@JsonProperty("region")
private String region;
- /** The storage URI for this region. */
+ /**
+ * Cloud storage URI of the location in this region. End the URI with `/*` to map every path under
+ * it as a prefix; within one mapping, either all URIs or none carry the `/*` suffix.
+ */
@JsonProperty("uri")
private String uri;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcCatalog.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcCatalog.java
index d81d172eb..4e1fbb738 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcCatalog.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcCatalog.java
@@ -10,7 +10,7 @@
/** A Unity Catalog catalog to replicate. */
@Generated
public class UcCatalog {
- /** The name of the UC catalog to replicate. */
+ /** Name of the Unity Catalog catalog to replicate. */
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcReplicationConfig.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcReplicationConfig.java
index 8b61b86b2..aa7b5a537 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcReplicationConfig.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UcReplicationConfig.java
@@ -11,18 +11,26 @@
/** Unity Catalog replication configuration (top-level, not per-set). */
@Generated
public class UcReplicationConfig {
- /** UC catalogs to replicate. */
+ /**
+ * Unity Catalog catalogs to replicate, including their metadata and managed table data. Adding a
+ * catalog to an existing failover group returns the group to INITIAL_REPLICATION until the
+ * catalog has been replicated.
+ */
@JsonProperty("catalogs")
private Collection catalogs;
/**
- * The workspace set whose workspaces will be used for data replication of all UC catalogs'
- * underlying storage.
+ * Name of the workspace set whose workspaces run the data replication for the catalogs'
+ * underlying storage. Must match the name of a workspace set in this failover group.
*/
@JsonProperty("data_replication_workspace_set")
private String dataReplicationWorkspaceSet;
- /** Location mappings - storage URI per region for each location. */
+ /**
+ * Storage location mappings. Each mapping pairs a storage path used by the replicated catalogs in
+ * one region with the corresponding path in the other region, so that replicated data is written
+ * to the matching storage in the secondary region.
+ */
@JsonProperty("location_mappings")
private Collection locationMappings;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UpdateFailoverGroupRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UpdateFailoverGroupRequest.java
index dea3350e6..e272b1848 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UpdateFailoverGroupRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/UpdateFailoverGroupRequest.java
@@ -34,7 +34,11 @@ public class UpdateFailoverGroupRequest {
*/
@JsonIgnore private String name;
- /** Comma-separated list of fields to update. */
+ /**
+ * Comma-separated list of the fields to update. The supported paths are `workspace_sets`,
+ * `unity_catalog_assets`, `unity_catalog_assets.catalogs` and
+ * `unity_catalog_assets.location_mappings`; any other path is rejected.
+ */
@JsonIgnore
@QueryParam("update_mask")
private FieldMask updateMask;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/WorkspaceSet.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/WorkspaceSet.java
index 73ff75dcf..6be113428 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/WorkspaceSet.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/disasterrecovery/WorkspaceSet.java
@@ -11,13 +11,16 @@
/** A set of workspaces that replicate to each other across regions. */
@Generated
public class WorkspaceSet {
- /** Resource name for this workspace set. */
+ /**
+ * Identifier of the workspace set, unique within the failover group and referenced by
+ * unity_catalog_assets.data_replication_workspace_set. Cannot be changed after creation.
+ */
@JsonProperty("name")
private String name;
/**
- * Whether to enable control plane DR (notebooks, jobs, clusters, etc.) for this set. Defaults to
- * false.
+ * Whether to replicate workspace assets (notebooks, jobs, clusters, SQL warehouses and so on) and
+ * their ACLs for this set. Defaults to false. Can be turned on or off with UpdateFailoverGroup.
*/
@JsonProperty("replicate_workspace_assets")
private Boolean replicateWorkspaceAssets;
@@ -25,14 +28,17 @@ public class WorkspaceSet {
/**
* Resource names of stable URLs associated with this workspace set. Format:
* accounts/{account_id}/stable-urls/{stable_url_id}. The referenced stable URLs must already
- * exist (via CreateStableUrl).
+ * exist (via CreateStableUrl), and the list can only be set when replicate_workspace_assets is
+ * true. While workspace asset replication stays enabled, an update can attach or detach one
+ * stable URL at a time.
*/
@JsonProperty("stable_url_names")
private Collection stableUrlNames;
/**
- * Workspace IDs in this set. The system derives and validates regions. All workspaces must be in
- * the Mission Critical tier.
+ * IDs of the two workspaces in this set, one in each of the failover group's regions. The system
+ * derives and validates each workspace's region. Both workspaces must belong to the account and
+ * have the Mission Critical add-on enabled, and they cannot be changed after creation.
*/
@JsonProperty("workspace_ids")
private Collection workspaceIds;
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 9ff5042e9..bf9370768 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
@@ -34,7 +34,7 @@ public EnvironmentsAPI(EnvironmentsService mock) {
* Creates a new WorkspaceBaseEnvironment. This is a long-running operation. The operation will
* asynchronously generate a materialized environment to optimize dependency resolution and is
* only marked as done when the materialized environment has been successfully generated or has
- * failed.
+ * failed. Poll the returned operation with GetOperation.
*/
public CreateWorkspaceBaseEnvironmentOperation createWorkspaceBaseEnvironment(
CreateWorkspaceBaseEnvironmentRequest request) {
@@ -49,7 +49,7 @@ public void deleteWorkspaceBaseEnvironment(String name) {
/**
* Deletes a WorkspaceBaseEnvironment. Deleting a base environment may impact linked notebooks and
* jobs. This operation is irreversible and should be performed only when you are certain the
- * environment is no longer needed.
+ * environment is no longer needed. Databricks-provided base environments cannot be deleted.
*/
public void deleteWorkspaceBaseEnvironment(DeleteWorkspaceBaseEnvironmentRequest request) {
impl.deleteWorkspaceBaseEnvironment(request);
@@ -75,7 +75,11 @@ public Operation getOperation(String name) {
/**
* Gets the status of a long-running operation. Clients can use this method to poll the operation
- * result.
+ * result. Create, update and refresh return an operation named
+ * `operations/{workspace_base_environment_id}`. The operation is done when the materialized
+ * environment build finishes. On success, `response` contains the WorkspaceBaseEnvironment with
+ * status `CREATED`. When the status is `FAILED`, `EXPIRED` or `INVALID`, `error` is set instead,
+ * and `error.message` carries the environment's status message when one is available.
*/
public Operation getOperation(GetOperationRequest request) {
return impl.getOperation(request);
@@ -125,7 +129,9 @@ public Iterable listWorkspaceBaseEnvironments(
* Refreshes the materialized environment for a WorkspaceBaseEnvironment. This is a long-running
* operation. The operation will asynchronously regenerate the materialized environment and is
* only marked as done when the materialized environment has been successfully generated or has
- * failed. The existing materialized environment remains available until it expires.
+ * failed. The existing materialized environment remains available until it expires. Poll the
+ * returned operation with GetOperation. Databricks-provided base environments cannot be
+ * refreshed.
*/
public RefreshWorkspaceBaseEnvironmentOperation refreshWorkspaceBaseEnvironment(
RefreshWorkspaceBaseEnvironmentRequest request) {
@@ -146,7 +152,8 @@ public DefaultWorkspaceBaseEnvironment updateDefaultWorkspaceBaseEnvironment(
* Updates an existing WorkspaceBaseEnvironment. This is a long-running operation. The operation
* will asynchronously regenerate the materialized environment and is only marked as done when the
* materialized environment has been successfully generated or has failed. The existing
- * materialized environment remains available until it expires.
+ * materialized environment remains available until it expires. Poll the returned operation with
+ * GetOperation. Databricks-provided base environments cannot be updated.
*/
public UpdateWorkspaceBaseEnvironmentOperation updateWorkspaceBaseEnvironment(
UpdateWorkspaceBaseEnvironmentRequest 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 945f703d8..f60448941 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
@@ -20,7 +20,7 @@ public interface EnvironmentsService {
* Creates a new WorkspaceBaseEnvironment. This is a long-running operation. The operation will
* asynchronously generate a materialized environment to optimize dependency resolution and is
* only marked as done when the materialized environment has been successfully generated or has
- * failed.
+ * failed. Poll the returned operation with GetOperation.
*/
Operation createWorkspaceBaseEnvironment(
CreateWorkspaceBaseEnvironmentRequest createWorkspaceBaseEnvironmentRequest);
@@ -28,7 +28,7 @@ Operation createWorkspaceBaseEnvironment(
/**
* Deletes a WorkspaceBaseEnvironment. Deleting a base environment may impact linked notebooks and
* jobs. This operation is irreversible and should be performed only when you are certain the
- * environment is no longer needed.
+ * environment is no longer needed. Databricks-provided base environments cannot be deleted.
*/
void deleteWorkspaceBaseEnvironment(
DeleteWorkspaceBaseEnvironmentRequest deleteWorkspaceBaseEnvironmentRequest);
@@ -42,7 +42,11 @@ DefaultWorkspaceBaseEnvironment getDefaultWorkspaceBaseEnvironment(
/**
* Gets the status of a long-running operation. Clients can use this method to poll the operation
- * result.
+ * result. Create, update and refresh return an operation named
+ * `operations/{workspace_base_environment_id}`. The operation is done when the materialized
+ * environment build finishes. On success, `response` contains the WorkspaceBaseEnvironment with
+ * status `CREATED`. When the status is `FAILED`, `EXPIRED` or `INVALID`, `error` is set instead,
+ * and `error.message` carries the environment's status message when one is available.
*/
Operation getOperation(GetOperationRequest getOperationRequest);
@@ -72,7 +76,9 @@ ListWorkspaceBaseEnvironmentsResponse listWorkspaceBaseEnvironments(
* Refreshes the materialized environment for a WorkspaceBaseEnvironment. This is a long-running
* operation. The operation will asynchronously regenerate the materialized environment and is
* only marked as done when the materialized environment has been successfully generated or has
- * failed. The existing materialized environment remains available until it expires.
+ * failed. The existing materialized environment remains available until it expires. Poll the
+ * returned operation with GetOperation. Databricks-provided base environments cannot be
+ * refreshed.
*/
Operation refreshWorkspaceBaseEnvironment(
RefreshWorkspaceBaseEnvironmentRequest refreshWorkspaceBaseEnvironmentRequest);
@@ -88,7 +94,8 @@ DefaultWorkspaceBaseEnvironment updateDefaultWorkspaceBaseEnvironment(
* Updates an existing WorkspaceBaseEnvironment. This is a long-running operation. The operation
* will asynchronously regenerate the materialized environment and is only marked as done when the
* materialized environment has been successfully generated or has failed. The existing
- * materialized environment remains available until it expires.
+ * materialized environment remains available until it expires. Poll the returned operation with
+ * GetOperation. Databricks-provided base environments cannot be updated.
*/
Operation updateWorkspaceBaseEnvironment(
UpdateWorkspaceBaseEnvironmentRequest updateWorkspaceBaseEnvironmentRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/RefreshWorkspaceBaseEnvironmentRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/RefreshWorkspaceBaseEnvironmentRequest.java
index bf415eb79..92aec6d5b 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/RefreshWorkspaceBaseEnvironmentRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/RefreshWorkspaceBaseEnvironmentRequest.java
@@ -11,7 +11,7 @@
@Generated
public class RefreshWorkspaceBaseEnvironmentRequest {
/**
- * Required. The resource name of the workspace base environment to delete. Format:
+ * Required. The resource name of the workspace base environment to refresh. Format:
* workspace-base-environments/{workspace_base_environment}
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateWorkspaceBaseEnvironmentRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateWorkspaceBaseEnvironmentRequest.java
index 7cdc5a7eb..65094a8b2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateWorkspaceBaseEnvironmentRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/UpdateWorkspaceBaseEnvironmentRequest.java
@@ -10,12 +10,17 @@
@Generated
public class UpdateWorkspaceBaseEnvironmentRequest {
- /** */
+ /**
+ * The resource name of the workspace base environment to update. Format:
+ * workspace-base-environments/{workspace_base_environment}
+ */
@JsonIgnore private String name;
/**
- * Required. The workspace base environment with updated fields. The name field is used to
- * identify the environment to update.
+ * The workspace base environment with its new configuration. The `name` path parameter identifies
+ * the environment to update. Set `display_name` and `filepath` on every update, even when they do
+ * not change. An update keeps the stored `base_environment_type`, but the YAML file is validated
+ * against the type in the request, which defaults to `CPU`, so also set it for a GPU environment.
*/
@JsonProperty("workspace_base_environment")
private WorkspaceBaseEnvironment workspaceBaseEnvironment;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/WorkspaceBaseEnvironment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/WorkspaceBaseEnvironment.java
index 211926f25..b99931c7d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/WorkspaceBaseEnvironment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/environments/WorkspaceBaseEnvironment.java
@@ -14,7 +14,7 @@
*/
@Generated
public class WorkspaceBaseEnvironment {
- /** The type of base environment (CPU or GPU). */
+ /** The type of base environment (CPU or GPU). The default is `CPU`. */
@JsonProperty("base_environment_type")
private BaseEnvironmentType baseEnvironmentType;
@@ -30,7 +30,11 @@ public class WorkspaceBaseEnvironment {
@JsonProperty("display_name")
private String displayName;
- /** The WSFS or UC Volumes path to the environment YAML file. */
+ /**
+ * The workspace file or Unity Catalog volume path to the YAML file that defines the environment
+ * version and dependencies. The file name must end in `.yaml` or `.yml`. Create and update
+ * requests must set this field.
+ */
@JsonProperty("filepath")
private String filepath;
@@ -42,22 +46,33 @@ public class WorkspaceBaseEnvironment {
@JsonProperty("last_updated_user_id")
private String lastUpdatedUserId;
- /** Status message providing additional details about the environment status. */
+ /**
+ * Status message providing additional details about the environment status. When the status is
+ * `FAILED`, the message contains the build error.
+ */
@JsonProperty("message")
private String message;
/**
* The resource name of the workspace base environment. Format:
- * workspace-base-environments/{workspace-base-environment}
+ * workspace-base-environments/{workspace-base-environment} The server ignores this field on
+ * create and builds the name from `workspace_base_environment_id`, or from `display_name` plus a
+ * random suffix when no ID is given.
*/
@JsonProperty("name")
private String name;
- /** The environment specification containing version and dependencies. */
+ /**
+ * The environment specification containing version and dependencies, read from the YAML file at
+ * `filepath`.
+ */
@JsonProperty("spec")
private EnvironmentSpec spec;
- /** The status of the materialized workspace base environment. */
+ /**
+ * The status of the materialized workspace base environment, which the server builds from the
+ * YAML file. The status is `CREATED` once the build has succeeded.
+ */
@JsonProperty("status")
private WorkspaceBaseEnvironmentCacheStatus status;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountGroup.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountGroup.java
index 81b026221..c7af73674 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountGroup.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountGroup.java
@@ -8,25 +8,41 @@
import java.util.Collection;
import java.util.Objects;
+/**
+ * Represents a group of users, service principals and other groups in the Databricks account.
+ * Members inherit the permissions that are granted to the group.
+ */
@Generated
public class AccountGroup {
- /** Databricks account ID */
+ /** Identifies the Databricks account that the group belongs to. */
@JsonProperty("account_id")
private String accountId;
- /** String that represents a human-readable group name */
+ /**
+ * Identifies the group by a human-readable name. The name must be unique within the account and
+ * must not exceed 255 characters.
+ */
@JsonProperty("displayName")
private String displayName;
- /** external_id should be unique for identifying groups */
+ /**
+ * Identifies the group in an external identity provider. Identity providers use it to match the
+ * groups they manage to Databricks groups, so it should be unique among the groups in the
+ * account.
+ */
@JsonProperty("externalId")
private String externalId;
- /** Databricks group ID */
+ /**
+ * Identifies the group within Databricks. Databricks generates the ID when the group is created.
+ */
@JsonProperty("id")
private String id;
- /** */
+ /**
+ * Lists the members of the group. Each entry identifies a user, service principal or group in the
+ * account by its ID in the value sub-attribute.
+ */
@JsonProperty("members")
private Collection members;
@@ -34,7 +50,10 @@ public class AccountGroup {
@JsonProperty("meta")
private ResourceMeta meta;
- /** Indicates if the group has the admin role. */
+ /**
+ * Lists the account roles that are assigned to the group. The only supported role value is
+ * `account_admin`.
+ */
@JsonProperty("roles")
private Collection roles;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipal.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipal.java
index a1b2acbf5..042848ec9 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipal.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipal.java
@@ -8,33 +8,53 @@
import java.util.Collection;
import java.util.Objects;
+/**
+ * Represents a service principal in the Databricks account. Service principals are identities for
+ * jobs, automated tools and systems such as scripts, apps and CI/CD platforms.
+ */
@Generated
public class AccountServicePrincipal {
- /** Databricks account ID */
+ /** Identifies the Databricks account that the service principal belongs to. */
@JsonProperty("account_id")
private String accountId;
- /** If this user is active */
+ /**
+ * Indicates whether the service principal is active. A deactivated service principal cannot
+ * authenticate or access Databricks APIs, but it keeps its permissions.
+ */
@JsonProperty("active")
private Boolean active;
- /** UUID relating to the service principal */
+ /**
+ * Identifies the service principal when it authenticates to Databricks. Databricks generates the
+ * application ID, except on Azure, where it can be the application ID of a Microsoft Entra ID
+ * service principal.
+ */
@JsonProperty("applicationId")
private String applicationId;
- /** String that represents a concatenation of given and family names. */
+ /** Identifies the service principal by a human-readable name. */
@JsonProperty("displayName")
private String displayName;
- /** */
+ /**
+ * Identifies the service principal in an external identity provider. Identity providers use it to
+ * match the service principals they manage to Databricks service principals.
+ */
@JsonProperty("externalId")
private String externalId;
- /** Databricks service principal ID. */
+ /**
+ * Identifies the service principal within Databricks. Databricks generates the ID when the
+ * service principal is created.
+ */
@JsonProperty("id")
private String id;
- /** Indicates if the group has the admin role. */
+ /**
+ * Lists the account roles that are assigned to the service principal. The only supported role
+ * value is `account_admin`.
+ */
@JsonProperty("roles")
private Collection roles;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2API.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2API.java
index cbac8a067..3079abd0d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2API.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2API.java
@@ -39,7 +39,7 @@ public void delete(String id) {
delete(new DeleteAccountServicePrincipalRequest().setId(id));
}
- /** Delete a single service principal in the Databricks account. */
+ /** Deletes a single service principal from the Databricks account. */
public void delete(DeleteAccountServicePrincipalRequest request) {
impl.delete(request);
}
@@ -48,7 +48,7 @@ public AccountServicePrincipal get(String id) {
return get(new GetAccountServicePrincipalRequest().setId(id));
}
- /** Gets the details for a single service principal define in the Databricks account. */
+ /** Gets the details for a single service principal in the Databricks account. */
public AccountServicePrincipal get(GetAccountServicePrincipalRequest request) {
return impl.get(request);
}
@@ -81,7 +81,7 @@ public void patch(PatchAccountServicePrincipalRequest request) {
/**
* Updates the details of a single service principal.
*
- * This action replaces the existing service principal with the same name.
+ *
This action replaces the existing service principal that has the given ID.
*/
public void update(UpdateAccountServicePrincipalRequest request) {
impl.update(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2Service.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2Service.java
index f5ed7835f..e3e002f79 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2Service.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/AccountServicePrincipalsV2Service.java
@@ -20,10 +20,10 @@ public interface AccountServicePrincipalsV2Service {
AccountServicePrincipal create(
CreateAccountServicePrincipalRequest createAccountServicePrincipalRequest);
- /** Delete a single service principal in the Databricks account. */
+ /** Deletes a single service principal from the Databricks account. */
void delete(DeleteAccountServicePrincipalRequest deleteAccountServicePrincipalRequest);
- /** Gets the details for a single service principal define in the Databricks account. */
+ /** Gets the details for a single service principal in the Databricks account. */
AccountServicePrincipal get(GetAccountServicePrincipalRequest getAccountServicePrincipalRequest);
/** Gets the set of service principals associated with a Databricks account. */
@@ -36,7 +36,7 @@ ListAccountServicePrincipalsResponse list(
/**
* Updates the details of a single service principal.
*
- *
This action replaces the existing service principal with the same name.
+ *
This action replaces the existing service principal that has the given ID.
*/
void update(UpdateAccountServicePrincipalRequest updateAccountServicePrincipalRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountGroupRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountGroupRequest.java
index 3d2181dcf..c83d0abda 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountGroupRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountGroupRequest.java
@@ -10,19 +10,25 @@
@Generated
public class CreateAccountGroupRequest {
- /** String that represents a human-readable group name */
+ /**
+ * Sets the human-readable name of the group. The name must be unique within the account and must
+ * not exceed 255 characters.
+ */
@JsonProperty("displayName")
private String displayName;
- /** */
+ /** Sets the identifier of the group in an external identity provider. */
@JsonProperty("externalId")
private String externalId;
- /** Databricks group ID */
+ /** Identifies the group within Databricks. */
@JsonProperty("id")
private String id;
- /** */
+ /**
+ * Lists the members of the group. Each entry identifies a user, service principal or group in the
+ * account by its ID in the value sub-attribute.
+ */
@JsonProperty("members")
private Collection members;
@@ -30,7 +36,10 @@ public class CreateAccountGroupRequest {
@JsonProperty("meta")
private ResourceMeta meta;
- /** Indicates if the group has the admin role. */
+ /**
+ * Lists the account roles that are assigned to the group. The only supported role value is
+ * `account_admin`.
+ */
@JsonProperty("roles")
private Collection roles;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountServicePrincipalRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountServicePrincipalRequest.java
index 5991f240a..e7a329392 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountServicePrincipalRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/CreateAccountServicePrincipalRequest.java
@@ -10,27 +10,40 @@
@Generated
public class CreateAccountServicePrincipalRequest {
- /** If this user is active */
+ /**
+ * Indicates whether the service principal is active. A deactivated service principal cannot
+ * authenticate or access Databricks APIs, but it keeps its permissions.
+ */
@JsonProperty("active")
private Boolean active;
- /** UUID relating to the service principal */
+ /**
+ * Sets the application ID of a Microsoft Entra ID service principal. Only Azure accepts this
+ * field. On AWS and GCP, Databricks generates the application ID and rejects requests that set
+ * it.
+ */
@JsonProperty("applicationId")
private String applicationId;
- /** String that represents a concatenation of given and family names. */
+ /**
+ * Sets the human-readable name of the service principal. The name is required unless the request
+ * sets `applicationId`.
+ */
@JsonProperty("displayName")
private String displayName;
- /** */
+ /** Sets the identifier of the service principal in an external identity provider. */
@JsonProperty("externalId")
private String externalId;
- /** Databricks service principal ID. */
+ /** Identifies the service principal within Databricks. */
@JsonProperty("id")
private String id;
- /** Indicates if the group has the admin role. */
+ /**
+ * Lists the account roles that are assigned to the service principal. The only supported role
+ * value is `account_admin`.
+ */
@JsonProperty("roles")
private Collection roles;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsRequest.java
index 2f646a7ed..9a157df1b 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsRequest.java
@@ -15,7 +15,9 @@ public class ListAccountGroupsRequest {
@QueryParam("attributes")
private String attributes;
- /** Desired number of results per page. Default is 10000. */
+ /**
+ * Specifies the number of results per page. When omitted, the server uses its default page size.
+ */
@JsonIgnore
@QueryParam("count")
private Long count;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsResponse.java
index 4a4982b41..3b958a4fc 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountGroupsResponse.java
@@ -14,7 +14,7 @@ public class ListAccountGroupsResponse {
@JsonProperty("itemsPerPage")
private Long itemsPerPage;
- /** User objects returned in the response. */
+ /** Group objects returned in the response. */
@JsonProperty("Resources")
private Collection resources;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountServicePrincipalsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountServicePrincipalsResponse.java
index 2a14f9906..16ee26865 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountServicePrincipalsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ListAccountServicePrincipalsResponse.java
@@ -14,7 +14,7 @@ public class ListAccountServicePrincipalsResponse {
@JsonProperty("itemsPerPage")
private Long itemsPerPage;
- /** User objects returned in the response. */
+ /** Lists the service principals that are returned in the response. */
@JsonProperty("Resources")
private Collection resources;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountGroupRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountGroupRequest.java
index 293a24b6d..afd81d760 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountGroupRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountGroupRequest.java
@@ -11,10 +11,10 @@
@Generated
public class PatchAccountGroupRequest {
- /** Unique ID in the Databricks workspace. */
+ /** Unique ID for a group in the Databricks account. */
@JsonIgnore private String id;
- /** */
+ /** Lists the patch operations to apply to the group. */
@JsonProperty("Operations")
private Collection operations;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountServicePrincipalRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountServicePrincipalRequest.java
index 8274e0b94..6cc550e47 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountServicePrincipalRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/PatchAccountServicePrincipalRequest.java
@@ -11,10 +11,10 @@
@Generated
public class PatchAccountServicePrincipalRequest {
- /** Unique ID in the Databricks workspace. */
+ /** Unique ID for a service principal in the Databricks account. */
@JsonIgnore private String id;
- /** */
+ /** Lists the patch operations to apply to the service principal. */
@JsonProperty("Operations")
private Collection operations;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ResourceInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ResourceInfo.java
index ea6f7556b..4621b21e9 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ResourceInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/ResourceInfo.java
@@ -20,7 +20,10 @@ public class ResourceInfo {
@QueryParam("legacy_acl_path")
private String legacyAclPath;
- /** Parent resource info for the current resource. The parent may have another parent. */
+ /**
+ * Deprecated: use `contributing_resources`. Parent resource info for the current resource. The
+ * parent may have another parent.
+ */
@JsonProperty("parent_resource_info")
@QueryParam("parent_resource_info")
private ResourceInfo parentResourceInfo;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountGroupRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountGroupRequest.java
index 7c1ead7b1..d63d27b6a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountGroupRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountGroupRequest.java
@@ -11,18 +11,24 @@
@Generated
public class UpdateAccountGroupRequest {
- /** String that represents a human-readable group name */
+ /**
+ * Sets the human-readable name of the group. The name must be unique within the account and must
+ * not exceed 255 characters.
+ */
@JsonProperty("displayName")
private String displayName;
- /** */
+ /** Sets the identifier of the group in an external identity provider. */
@JsonProperty("externalId")
private String externalId;
- /** Databricks group ID */
+ /** Identifies the group within Databricks. */
@JsonIgnore private String id;
- /** */
+ /**
+ * Lists the members of the group. Each entry identifies a user, service principal or group in the
+ * account by its ID in the value sub-attribute.
+ */
@JsonProperty("members")
private Collection members;
@@ -30,7 +36,10 @@ public class UpdateAccountGroupRequest {
@JsonProperty("meta")
private ResourceMeta meta;
- /** Indicates if the group has the admin role. */
+ /**
+ * Lists the account roles that are assigned to the group. The only supported role value is
+ * `account_admin`.
+ */
@JsonProperty("roles")
private Collection roles;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountServicePrincipalRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountServicePrincipalRequest.java
index 398e284f5..c4309875d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountServicePrincipalRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/iam/UpdateAccountServicePrincipalRequest.java
@@ -11,26 +11,39 @@
@Generated
public class UpdateAccountServicePrincipalRequest {
- /** If this user is active */
+ /**
+ * Indicates whether the service principal is active. A deactivated service principal cannot
+ * authenticate or access Databricks APIs, but it keeps its permissions.
+ */
@JsonProperty("active")
private Boolean active;
- /** UUID relating to the service principal */
+ /**
+ * Sets the application ID of a Microsoft Entra ID service principal. Only Azure accepts this
+ * field. On AWS and GCP, Databricks generates the application ID and rejects requests that set
+ * it.
+ */
@JsonProperty("applicationId")
private String applicationId;
- /** String that represents a concatenation of given and family names. */
+ /**
+ * Sets the human-readable name of the service principal. The name is required unless the request
+ * sets `applicationId`.
+ */
@JsonProperty("displayName")
private String displayName;
- /** */
+ /** Sets the identifier of the service principal in an external identity provider. */
@JsonProperty("externalId")
private String externalId;
- /** Databricks service principal ID. */
+ /** Identifies the service principal within Databricks. */
@JsonIgnore private String id;
- /** Indicates if the group has the admin role. */
+ /**
+ * Lists the account roles that are assigned to the service principal. The only supported role
+ * value is `account_admin`.
+ */
@JsonProperty("roles")
private Collection roles;
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 6ca93f838..60cbf32da 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
@@ -18,11 +18,18 @@ public class Group {
@JsonProperty("external_id")
private String externalId;
- /** The Databricks ID of the group. */
+ /**
+ * The Databricks ID of the group. It is a numeric string that Databricks assigns when the group
+ * is created, and it is the `{group_id}` segment of `name`.
+ */
@JsonProperty("group_id")
private String groupId;
- /** The name of the group. */
+ /**
+ * The display name of the group. It must be unique in the account, must not be blank, and must be
+ * shorter than 255 characters. Databricks trims surrounding whitespace. You can't use the name of
+ * a group that Databricks manages, such as `admins` or `users`.
+ */
@JsonProperty("group_name")
private String groupName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SqlConditionConfiguration.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SqlConditionConfiguration.java
index 1f1f92c23..a06f6345a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SqlConditionConfiguration.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SqlConditionConfiguration.java
@@ -9,7 +9,10 @@
@Generated
public class SqlConditionConfiguration {
- /** The ID of the SQL query to evaluate as the trigger condition. */
+ /**
+ * The ID of the SQL query to evaluate as the trigger condition. Exactly one of `sql_query_id` or
+ * `file` must be set.
+ */
@JsonProperty("sql_query_id")
private String sqlQueryId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/BuiltinParser.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/BuiltinParser.java
new file mode 100644
index 000000000..264873c86
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/BuiltinParser.java
@@ -0,0 +1,121 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Collection;
+import java.util.Objects;
+
+/**
+ * A Databricks-authored parser, shared by every customer.
+ *
+ * Same container-plus-versions shape as the custom `Parser`, and addressed the same way, by
+ * UUID. Built-ins are global rather than catalog-scoped, so they carry no owning catalog or schema.
+ */
+@Generated
+public class BuiltinParser {
+ /** Newest published version number. */
+ @JsonProperty("latest_version")
+ private Long latestVersion;
+
+ /** Resource name. Format: `builtin-parsers/{parser_id}`. */
+ @JsonProperty("name")
+ private String name;
+
+ /**
+ * The parser's UUID, authored into the built-in's published definition rather than minted per
+ * customer, so every workspace addresses the same built-in by the same id. It is the leaf of
+ * `name`.
+ */
+ @JsonProperty("parser_id")
+ private String parserId;
+
+ /**
+ * The built-in's own leaf name, as published in content-marketplace. Stable and human-readable,
+ * which is what a UI shows; `name` addresses the resource by id.
+ */
+ @JsonProperty("parser_name")
+ private String parserName;
+
+ /**
+ * Key/value tags describing this parser, e.g. `cloud_provider=aws` or `log_source=cloudtrail`. A
+ * parser may carry up to 32. Filterable on list.
+ */
+ @JsonProperty("tags")
+ private Collection tags;
+
+ public BuiltinParser setLatestVersion(Long latestVersion) {
+ this.latestVersion = latestVersion;
+ return this;
+ }
+
+ public Long getLatestVersion() {
+ return latestVersion;
+ }
+
+ public BuiltinParser setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public BuiltinParser setParserId(String parserId) {
+ this.parserId = parserId;
+ return this;
+ }
+
+ public String getParserId() {
+ return parserId;
+ }
+
+ public BuiltinParser setParserName(String parserName) {
+ this.parserName = parserName;
+ return this;
+ }
+
+ public String getParserName() {
+ return parserName;
+ }
+
+ public BuiltinParser setTags(Collection tags) {
+ this.tags = tags;
+ return this;
+ }
+
+ public Collection getTags() {
+ return tags;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ BuiltinParser that = (BuiltinParser) o;
+ return Objects.equals(latestVersion, that.latestVersion)
+ && Objects.equals(name, that.name)
+ && Objects.equals(parserId, that.parserId)
+ && Objects.equals(parserName, that.parserName)
+ && Objects.equals(tags, that.tags);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(latestVersion, name, parserId, parserName, tags);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(BuiltinParser.class)
+ .add("latestVersion", latestVersion)
+ .add("name", name)
+ .add("parserId", parserId)
+ .add("parserName", parserName)
+ .add("tags", tags)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/BuiltinParserVersion.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/BuiltinParserVersion.java
new file mode 100644
index 000000000..14da34d45
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/BuiltinParserVersion.java
@@ -0,0 +1,136 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Collection;
+import java.util.Objects;
+
+/**
+ * One published version of a built-in parser, carrying the spec.
+ *
+ * The content pipeline owns versioning, so unlike the custom version there is no authoring
+ * principal and no append timestamp here.
+ */
+@Generated
+public class BuiltinParserVersion {
+ /** Free-form description of this parser, authored by Databricks. */
+ @JsonProperty("description")
+ private String description;
+
+ /** Resource name. Format: `builtin-parsers/{parser_id}/versions/{version}`. */
+ @JsonProperty("name")
+ private String name;
+
+ /**
+ * The parent built-in's published leaf name, copied from the container on read. Denormalized so a
+ * caller that needs identity alongside the spec reads the version alone rather than the container
+ * as well. Populated by `GetBuiltinParserVersion`; List omits it, as List omits `spec`.
+ */
+ @JsonProperty("parser_name")
+ private String parserName;
+
+ /**
+ * The parser spec: the field definitions for this log source, as a YAML document. Read-only;
+ * built-in specs are authored by Databricks, so no client-facing size cap is enforced here.
+ */
+ @JsonProperty("spec")
+ private String spec;
+
+ /**
+ * The parent built-in's tags, copied from the container on read. Rendering reads these for
+ * connector-specific details, such as the source table a Lakeflow Connect parser reads.
+ */
+ @JsonProperty("tags")
+ private Collection tags;
+
+ /** Version number. */
+ @JsonProperty("version")
+ private Long version;
+
+ public BuiltinParserVersion setDescription(String description) {
+ this.description = description;
+ return this;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public BuiltinParserVersion setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public BuiltinParserVersion setParserName(String parserName) {
+ this.parserName = parserName;
+ return this;
+ }
+
+ public String getParserName() {
+ return parserName;
+ }
+
+ public BuiltinParserVersion setSpec(String spec) {
+ this.spec = spec;
+ return this;
+ }
+
+ public String getSpec() {
+ return spec;
+ }
+
+ public BuiltinParserVersion setTags(Collection tags) {
+ this.tags = tags;
+ return this;
+ }
+
+ public Collection getTags() {
+ return tags;
+ }
+
+ public BuiltinParserVersion setVersion(Long version) {
+ this.version = version;
+ return this;
+ }
+
+ public Long getVersion() {
+ return version;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ BuiltinParserVersion that = (BuiltinParserVersion) o;
+ return Objects.equals(description, that.description)
+ && Objects.equals(name, that.name)
+ && Objects.equals(parserName, that.parserName)
+ && Objects.equals(spec, that.spec)
+ && Objects.equals(tags, that.tags)
+ && Objects.equals(version, that.version);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(description, name, parserName, spec, tags, version);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(BuiltinParserVersion.class)
+ .add("description", description)
+ .add("name", name)
+ .add("parserName", parserName)
+ .add("spec", spec)
+ .add("tags", tags)
+ .add("version", version)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/CreateParserRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/CreateParserRequest.java
new file mode 100644
index 000000000..283a63a02
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/CreateParserRequest.java
@@ -0,0 +1,42 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+@Generated
+public class CreateParserRequest {
+ /** The parser to create. `spec` and `description` become version 1. */
+ @JsonProperty("parser")
+ private Parser parser;
+
+ public CreateParserRequest setParser(Parser parser) {
+ this.parser = parser;
+ return this;
+ }
+
+ public Parser getParser() {
+ return parser;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ CreateParserRequest that = (CreateParserRequest) o;
+ return Objects.equals(parser, that.parser);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(parser);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(CreateParserRequest.class).add("parser", parser).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/CreateParserVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/CreateParserVersionRequest.java
new file mode 100644
index 000000000..e1d32c7da
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/CreateParserVersionRequest.java
@@ -0,0 +1,58 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+@Generated
+public class CreateParserVersionRequest {
+ /** Resource name of the parser to append a version to. Format: `parsers/{parser_id}`. */
+ @JsonIgnore private String parent;
+
+ /** The version to append. */
+ @JsonProperty("parser_version")
+ private ParserVersion parserVersion;
+
+ public CreateParserVersionRequest setParent(String parent) {
+ this.parent = parent;
+ return this;
+ }
+
+ public String getParent() {
+ return parent;
+ }
+
+ public CreateParserVersionRequest setParserVersion(ParserVersion parserVersion) {
+ this.parserVersion = parserVersion;
+ return this;
+ }
+
+ public ParserVersion getParserVersion() {
+ return parserVersion;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ CreateParserVersionRequest that = (CreateParserVersionRequest) o;
+ return Objects.equals(parent, that.parent) && Objects.equals(parserVersion, that.parserVersion);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(parent, parserVersion);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(CreateParserVersionRequest.class)
+ .add("parent", parent)
+ .add("parserVersion", parserVersion)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/DeleteParserRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/DeleteParserRequest.java
new file mode 100644
index 000000000..d2391f0f2
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/DeleteParserRequest.java
@@ -0,0 +1,41 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 DeleteParserRequest {
+ /** Resource name of the parser. Format: `parsers/{parser_id}`. */
+ @JsonIgnore private String name;
+
+ public DeleteParserRequest 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;
+ DeleteParserRequest that = (DeleteParserRequest) o;
+ return Objects.equals(name, that.name);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(name);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(DeleteParserRequest.class).add("name", name).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/DeleteParserVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/DeleteParserVersionRequest.java
new file mode 100644
index 000000000..57c4924fd
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/DeleteParserVersionRequest.java
@@ -0,0 +1,46 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 DeleteParserVersionRequest {
+ /**
+ * Resource name of the version. Format: `parsers/{parser_id}/versions/{version}`, where
+ * `{version}` is a version number written without sign or leading zeros, such as `3`. Unlike
+ * GetParserVersion, the alias `latest` and forms such as `007` or `+3` are rejected, so a delete
+ * always names one fixed version.
+ */
+ @JsonIgnore private String name;
+
+ public DeleteParserVersionRequest 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;
+ DeleteParserVersionRequest that = (DeleteParserVersionRequest) o;
+ return Objects.equals(name, that.name);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(name);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(DeleteParserVersionRequest.class).add("name", name).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetBuiltinParserRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetBuiltinParserRequest.java
new file mode 100644
index 000000000..c80add590
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetBuiltinParserRequest.java
@@ -0,0 +1,41 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 GetBuiltinParserRequest {
+ /** Resource name. Format: `builtin-parsers/{parser_id}`. */
+ @JsonIgnore private String name;
+
+ public GetBuiltinParserRequest 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;
+ GetBuiltinParserRequest that = (GetBuiltinParserRequest) o;
+ return Objects.equals(name, that.name);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(name);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(GetBuiltinParserRequest.class).add("name", name).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetBuiltinParserVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetBuiltinParserVersionRequest.java
new file mode 100644
index 000000000..9fab10382
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetBuiltinParserVersionRequest.java
@@ -0,0 +1,44 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 GetBuiltinParserVersionRequest {
+ /**
+ * Resource name of the version. Format: `builtin-parsers/{parser_id}/versions/{version}`, where
+ * `{version}` is either a version number or the alias `latest`.
+ */
+ @JsonIgnore private String name;
+
+ public GetBuiltinParserVersionRequest 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;
+ GetBuiltinParserVersionRequest that = (GetBuiltinParserVersionRequest) o;
+ return Objects.equals(name, that.name);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(name);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(GetBuiltinParserVersionRequest.class).add("name", name).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetParserRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetParserRequest.java
new file mode 100644
index 000000000..d9f54d071
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetParserRequest.java
@@ -0,0 +1,41 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 GetParserRequest {
+ /** Resource name of the parser. Format: `parsers/{parser_id}`. */
+ @JsonIgnore private String name;
+
+ public GetParserRequest 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;
+ GetParserRequest that = (GetParserRequest) o;
+ return Objects.equals(name, that.name);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(name);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(GetParserRequest.class).add("name", name).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetParserVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetParserVersionRequest.java
new file mode 100644
index 000000000..8b5f55749
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/GetParserVersionRequest.java
@@ -0,0 +1,45 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 GetParserVersionRequest {
+ /**
+ * Resource name of the version. Format: `parsers/{parser_id}/versions/{version}`, where
+ * `{version}` is either a version number or the alias `latest`. `latest` is NOT_FOUND when every
+ * version of the parser has been deleted.
+ */
+ @JsonIgnore private String name;
+
+ public GetParserVersionRequest 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;
+ GetParserVersionRequest that = (GetParserVersionRequest) o;
+ return Objects.equals(name, that.name);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(name);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(GetParserVersionRequest.class).add("name", name).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchAPI.java
index 2e3c9fced..b600c1282 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchAPI.java
@@ -32,6 +32,19 @@ public Datasource createDatasource(CreateDatasourceRequest request) {
return impl.createDatasource(request);
}
+ /** Creates a parser and its first version in one call. */
+ public Parser createParser(CreateParserRequest request) {
+ return impl.createParser(request);
+ }
+
+ /**
+ * Appends a new immutable version, advancing the parser's latest-version pointer. This is how a
+ * parser is edited; versions are never changed in place.
+ */
+ public ParserVersion createParserVersion(CreateParserVersionRequest request) {
+ return impl.createParserVersion(request);
+ }
+
/** Creates a new rule. */
public Rule createRule(CreateRuleRequest request) {
return impl.createRule(request);
@@ -46,6 +59,28 @@ public void deleteDatasource(DeleteDatasourceRequest request) {
impl.deleteDatasource(request);
}
+ public void deleteParser(String name) {
+ deleteParser(new DeleteParserRequest().setName(name));
+ }
+
+ /** Deletes a parser and all of its versions. Refused while any data source references it. */
+ public void deleteParser(DeleteParserRequest request) {
+ impl.deleteParser(request);
+ }
+
+ public void deleteParserVersion(String name) {
+ deleteParserVersion(new DeleteParserVersionRequest().setName(name));
+ }
+
+ /**
+ * Deletes one version of a parser. Returns NOT_FOUND when the parser or the version does not
+ * exist, and a conflict (HTTP 409) only while a data source references the version. Deleting the
+ * last version leaves the parser in place with no versions.
+ */
+ public void deleteParserVersion(DeleteParserVersionRequest request) {
+ impl.deleteParserVersion(request);
+ }
+
public void deleteRule(String name) {
deleteRule(new DeleteRuleRequest().setName(name));
}
@@ -64,6 +99,24 @@ public AlertConfig getAlertConfig(GetAlertConfigRequest request) {
return impl.getAlertConfig(request);
}
+ public BuiltinParser getBuiltinParser(String name) {
+ return getBuiltinParser(new GetBuiltinParserRequest().setName(name));
+ }
+
+ /** Returns a built-in parser's identity and latest-version pointer. Does not return the spec. */
+ public BuiltinParser getBuiltinParser(GetBuiltinParserRequest request) {
+ return impl.getBuiltinParser(request);
+ }
+
+ public BuiltinParserVersion getBuiltinParserVersion(String name) {
+ return getBuiltinParserVersion(new GetBuiltinParserVersionRequest().setName(name));
+ }
+
+ /** Returns one version of a built-in parser, including its spec. */
+ public BuiltinParserVersion getBuiltinParserVersion(GetBuiltinParserVersionRequest request) {
+ return impl.getBuiltinParserVersion(request);
+ }
+
public CommonConfig getCommonConfig(String name) {
return getCommonConfig(new GetCommonConfigRequest().setName(name));
}
@@ -91,6 +144,27 @@ public DatasourceConfig getDatasourceConfig(GetDatasourceConfigRequest request)
return impl.getDatasourceConfig(request);
}
+ public Parser getParser(String name) {
+ return getParser(new GetParserRequest().setName(name));
+ }
+
+ /**
+ * Returns a parser's identity and latest-version pointer. Does not return the spec; read a spec
+ * with GetParserVersion.
+ */
+ public Parser getParser(GetParserRequest request) {
+ return impl.getParser(request);
+ }
+
+ public ParserVersion getParserVersion(String name) {
+ return getParserVersion(new GetParserVersionRequest().setName(name));
+ }
+
+ /** Returns one version of a parser, including its spec. */
+ public ParserVersion getParserVersion(GetParserVersionRequest request) {
+ return impl.getParserVersion(request);
+ }
+
public Rule getRule(String name) {
return getRule(new GetRuleRequest().setName(name));
}
@@ -109,6 +183,44 @@ public RuleConfig getRuleConfig(GetRuleConfigRequest request) {
return impl.getRuleConfig(request);
}
+ public Iterable listBuiltinParserVersions(String parent) {
+ return listBuiltinParserVersions(new ListBuiltinParserVersionsRequest().setParent(parent));
+ }
+
+ /**
+ * Lists a built-in parser's published versions, oldest first (ascending 1..resource_revision),
+ * without their specs.
+ */
+ public Iterable listBuiltinParserVersions(
+ ListBuiltinParserVersionsRequest request) {
+ return Paginator.newTokenPagination(
+ request,
+ impl::listBuiltinParserVersions,
+ ListBuiltinParserVersionsResponse::getBuiltinParserVersions,
+ response -> {
+ String token = response.getNextPageToken();
+ if (token == null || token.isEmpty()) {
+ return null;
+ }
+ return request.setPageToken(token);
+ });
+ }
+
+ /** Lists the built-in parsers Databricks publishes, without their specs. */
+ public Iterable listBuiltinParsers(ListBuiltinParsersRequest request) {
+ return Paginator.newTokenPagination(
+ request,
+ impl::listBuiltinParsers,
+ ListBuiltinParsersResponse::getBuiltinParsers,
+ response -> {
+ String token = response.getNextPageToken();
+ if (token == null || token.isEmpty()) {
+ return null;
+ }
+ return request.setPageToken(token);
+ });
+ }
+
public Iterable listDatasources(String catalogName) {
return listDatasources(new ListDatasourcesRequest().setCatalogName(catalogName));
}
@@ -132,6 +244,44 @@ public Iterable listDatasources(ListDatasourcesRequest request) {
});
}
+ public Iterable listParserVersions(String parent) {
+ return listParserVersions(new ListParserVersionsRequest().setParent(parent));
+ }
+
+ /** Lists a parser's versions, oldest first, without their specs. */
+ public Iterable listParserVersions(ListParserVersionsRequest request) {
+ return Paginator.newTokenPagination(
+ request,
+ impl::listParserVersions,
+ ListParserVersionsResponse::getParserVersions,
+ response -> {
+ String token = response.getNextPageToken();
+ if (token == null || token.isEmpty()) {
+ return null;
+ }
+ return request.setPageToken(token);
+ });
+ }
+
+ public Iterable listParsers(String catalogName) {
+ return listParsers(new ListParsersRequest().setCatalogName(catalogName));
+ }
+
+ /** Lists parsers in a catalog, without their specs. */
+ public Iterable listParsers(ListParsersRequest request) {
+ return Paginator.newTokenPagination(
+ request,
+ impl::listParsers,
+ ListParsersResponse::getParsers,
+ response -> {
+ String token = response.getNextPageToken();
+ if (token == null || token.isEmpty()) {
+ return null;
+ }
+ return request.setPageToken(token);
+ });
+ }
+
public Iterable listRules(String catalogName) {
return listRules(new ListRulesRequest().setCatalogName(catalogName));
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchImpl.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchImpl.java
index cccf14068..e3476db61 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchImpl.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchImpl.java
@@ -34,6 +34,42 @@ public Datasource createDatasource(CreateDatasourceRequest request) {
}
}
+ @Override
+ public Parser createParser(CreateParserRequest request) {
+ String path = "/api/2.0/lakewatch/parsers";
+ try {
+ Request req = new Request("POST", path, apiClient.serialize(request.getParser()));
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ req.withHeader("Content-Type", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, Parser.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
+ @Override
+ public ParserVersion createParserVersion(CreateParserVersionRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%s/versions", request.getParent());
+ try {
+ Request req = new Request("POST", path, apiClient.serialize(request.getParserVersion()));
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ req.withHeader("Content-Type", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, ParserVersion.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
@Override
public Rule createRule(CreateRuleRequest request) {
String path = "/api/2.0/lakewatch/rules";
@@ -69,6 +105,40 @@ public void deleteDatasource(DeleteDatasourceRequest request) {
}
}
+ @Override
+ public void deleteParser(DeleteParserRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%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 deleteParserVersion(DeleteParserVersionRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%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 deleteRule(DeleteRuleRequest request) {
String path = String.format("/api/2.0/lakewatch/%s", request.getName());
@@ -103,6 +173,40 @@ public AlertConfig getAlertConfig(GetAlertConfigRequest request) {
}
}
+ @Override
+ public BuiltinParser getBuiltinParser(GetBuiltinParserRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%s", request.getName());
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, BuiltinParser.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
+ @Override
+ public BuiltinParserVersion getBuiltinParserVersion(GetBuiltinParserVersionRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%s", request.getName());
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, BuiltinParserVersion.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
@Override
public CommonConfig getCommonConfig(GetCommonConfigRequest request) {
String path = String.format("/api/2.0/lakewatch/%s", request.getName());
@@ -154,6 +258,40 @@ public DatasourceConfig getDatasourceConfig(GetDatasourceConfigRequest request)
}
}
+ @Override
+ public Parser getParser(GetParserRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%s", request.getName());
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, Parser.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
+ @Override
+ public ParserVersion getParserVersion(GetParserVersionRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%s", request.getName());
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, ParserVersion.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
@Override
public Rule getRule(GetRuleRequest request) {
String path = String.format("/api/2.0/lakewatch/%s", request.getName());
@@ -188,6 +326,41 @@ public RuleConfig getRuleConfig(GetRuleConfigRequest request) {
}
}
+ @Override
+ public ListBuiltinParserVersionsResponse listBuiltinParserVersions(
+ ListBuiltinParserVersionsRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%s/versions", request.getParent());
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, ListBuiltinParserVersionsResponse.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
+ @Override
+ public ListBuiltinParsersResponse listBuiltinParsers(ListBuiltinParsersRequest request) {
+ String path = "/api/2.0/lakewatch/builtin-parsers";
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, ListBuiltinParsersResponse.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
@Override
public ListDatasourcesResponse listDatasources(ListDatasourcesRequest request) {
String path = "/api/2.0/lakewatch/datasources";
@@ -205,6 +378,40 @@ public ListDatasourcesResponse listDatasources(ListDatasourcesRequest request) {
}
}
+ @Override
+ public ListParserVersionsResponse listParserVersions(ListParserVersionsRequest request) {
+ String path = String.format("/api/2.0/lakewatch/%s/versions", request.getParent());
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, ListParserVersionsResponse.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
+ @Override
+ public ListParsersResponse listParsers(ListParsersRequest request) {
+ String path = "/api/2.0/lakewatch/parsers";
+ try {
+ Request req = new Request("GET", path);
+
+ ApiClient.setQuery(req, request);
+ req.withHeader("Accept", "application/json");
+ if (apiClient.workspaceId() != null) {
+ req.withHeader("X-Databricks-Workspace-Id", apiClient.workspaceId());
+ }
+ return apiClient.execute(req, ListParsersResponse.class);
+ } catch (IOException e) {
+ throw new DatabricksException("IO error: " + e.getMessage(), e);
+ }
+ }
+
@Override
public ListRulesResponse listRules(ListRulesRequest request) {
String path = "/api/2.0/lakewatch/rules";
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchService.java
index aeb8db62f..17a4446e5 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/LakewatchService.java
@@ -16,18 +16,44 @@ public interface LakewatchService {
/** Creates a new datasource. */
Datasource createDatasource(CreateDatasourceRequest createDatasourceRequest);
+ /** Creates a parser and its first version in one call. */
+ Parser createParser(CreateParserRequest createParserRequest);
+
+ /**
+ * Appends a new immutable version, advancing the parser's latest-version pointer. This is how a
+ * parser is edited; versions are never changed in place.
+ */
+ ParserVersion createParserVersion(CreateParserVersionRequest createParserVersionRequest);
+
/** Creates a new rule. */
Rule createRule(CreateRuleRequest createRuleRequest);
/** Deletes a datasource by its resource name. */
void deleteDatasource(DeleteDatasourceRequest deleteDatasourceRequest);
+ /** Deletes a parser and all of its versions. Refused while any data source references it. */
+ void deleteParser(DeleteParserRequest deleteParserRequest);
+
+ /**
+ * Deletes one version of a parser. Returns NOT_FOUND when the parser or the version does not
+ * exist, and a conflict (HTTP 409) only while a data source references the version. Deleting the
+ * last version leaves the parser in place with no versions.
+ */
+ void deleteParserVersion(DeleteParserVersionRequest deleteParserVersionRequest);
+
/** Deletes a rule by its resource name. */
void deleteRule(DeleteRuleRequest deleteRuleRequest);
/** Returns the alert delivery configuration for a catalog. */
AlertConfig getAlertConfig(GetAlertConfigRequest getAlertConfigRequest);
+ /** Returns a built-in parser's identity and latest-version pointer. Does not return the spec. */
+ BuiltinParser getBuiltinParser(GetBuiltinParserRequest getBuiltinParserRequest);
+
+ /** Returns one version of a built-in parser, including its spec. */
+ BuiltinParserVersion getBuiltinParserVersion(
+ GetBuiltinParserVersionRequest getBuiltinParserVersionRequest);
+
/** Returns the common Lakewatch configuration for a catalog. */
CommonConfig getCommonConfig(GetCommonConfigRequest getCommonConfigRequest);
@@ -37,12 +63,32 @@ public interface LakewatchService {
/** Returns the datasource ingestion configuration for a catalog. */
DatasourceConfig getDatasourceConfig(GetDatasourceConfigRequest getDatasourceConfigRequest);
+ /**
+ * Returns a parser's identity and latest-version pointer. Does not return the spec; read a spec
+ * with GetParserVersion.
+ */
+ Parser getParser(GetParserRequest getParserRequest);
+
+ /** Returns one version of a parser, including its spec. */
+ ParserVersion getParserVersion(GetParserVersionRequest getParserVersionRequest);
+
/** Returns a single rule by its resource name. */
Rule getRule(GetRuleRequest getRuleRequest);
/** Returns the detection-rule configuration for a catalog. */
RuleConfig getRuleConfig(GetRuleConfigRequest getRuleConfigRequest);
+ /**
+ * Lists a built-in parser's published versions, oldest first (ascending 1..resource_revision),
+ * without their specs.
+ */
+ ListBuiltinParserVersionsResponse listBuiltinParserVersions(
+ ListBuiltinParserVersionsRequest listBuiltinParserVersionsRequest);
+
+ /** Lists the built-in parsers Databricks publishes, without their specs. */
+ ListBuiltinParsersResponse listBuiltinParsers(
+ ListBuiltinParsersRequest listBuiltinParsersRequest);
+
/**
* Lists the datasources in a Unity Catalog catalog, optionally narrowed to one schema or filtered
* by name. Results are paginated. Datasources that are still being created or deleted are not
@@ -50,6 +96,13 @@ public interface LakewatchService {
*/
ListDatasourcesResponse listDatasources(ListDatasourcesRequest listDatasourcesRequest);
+ /** Lists a parser's versions, oldest first, without their specs. */
+ ListParserVersionsResponse listParserVersions(
+ ListParserVersionsRequest listParserVersionsRequest);
+
+ /** Lists parsers in a catalog, without their specs. */
+ ListParsersResponse listParsers(ListParsersRequest listParsersRequest);
+
/** Lists rules, with optional filtering and pagination. */
ListRulesResponse listRules(ListRulesRequest listRulesRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParserVersionsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParserVersionsRequest.java
new file mode 100644
index 000000000..18e8947cd
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParserVersionsRequest.java
@@ -0,0 +1,85 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 ListBuiltinParserVersionsRequest {
+ /**
+ * Maximum number of results to return in one page. If unset or 0, at most 100 versions are
+ * returned. The maximum allowed value is 1000.
+ */
+ @JsonIgnore
+ @QueryParam("page_size")
+ private Long pageSize;
+
+ /**
+ * Page token from a previous `ListBuiltinParserVersions` response, used to fetch the next page of
+ * results.
+ */
+ @JsonIgnore
+ @QueryParam("page_token")
+ private String pageToken;
+
+ /**
+ * Resource name of the built-in parser whose versions are listed. Format:
+ * `builtin-parsers/{parser_id}`.
+ */
+ @JsonIgnore private String parent;
+
+ public ListBuiltinParserVersionsRequest setPageSize(Long pageSize) {
+ this.pageSize = pageSize;
+ return this;
+ }
+
+ public Long getPageSize() {
+ return pageSize;
+ }
+
+ public ListBuiltinParserVersionsRequest setPageToken(String pageToken) {
+ this.pageToken = pageToken;
+ return this;
+ }
+
+ public String getPageToken() {
+ return pageToken;
+ }
+
+ public ListBuiltinParserVersionsRequest setParent(String parent) {
+ this.parent = parent;
+ return this;
+ }
+
+ public String getParent() {
+ return parent;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListBuiltinParserVersionsRequest that = (ListBuiltinParserVersionsRequest) o;
+ return Objects.equals(pageSize, that.pageSize)
+ && Objects.equals(pageToken, that.pageToken)
+ && Objects.equals(parent, that.parent);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(pageSize, pageToken, parent);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListBuiltinParserVersionsRequest.class)
+ .add("pageSize", pageSize)
+ .add("pageToken", pageToken)
+ .add("parent", parent)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParserVersionsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParserVersionsResponse.java
new file mode 100644
index 000000000..7fb259fbc
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParserVersionsResponse.java
@@ -0,0 +1,65 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Collection;
+import java.util.Objects;
+
+/** A page of built-in version metadata, without the specs. */
+@Generated
+public class ListBuiltinParserVersionsResponse {
+ /** Version metadata only, oldest first, without the spec. */
+ @JsonProperty("builtin_parser_versions")
+ private Collection builtinParserVersions;
+
+ /**
+ * Opaque token for fetching the next page; pass it as `page_token` on the next call. It is empty
+ * when there are no more results.
+ */
+ @JsonProperty("next_page_token")
+ private String nextPageToken;
+
+ public ListBuiltinParserVersionsResponse setBuiltinParserVersions(
+ Collection builtinParserVersions) {
+ this.builtinParserVersions = builtinParserVersions;
+ return this;
+ }
+
+ public Collection getBuiltinParserVersions() {
+ return builtinParserVersions;
+ }
+
+ public ListBuiltinParserVersionsResponse setNextPageToken(String nextPageToken) {
+ this.nextPageToken = nextPageToken;
+ return this;
+ }
+
+ public String getNextPageToken() {
+ return nextPageToken;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListBuiltinParserVersionsResponse that = (ListBuiltinParserVersionsResponse) o;
+ return Objects.equals(builtinParserVersions, that.builtinParserVersions)
+ && Objects.equals(nextPageToken, that.nextPageToken);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(builtinParserVersions, nextPageToken);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListBuiltinParserVersionsResponse.class)
+ .add("builtinParserVersions", builtinParserVersions)
+ .add("nextPageToken", nextPageToken)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParsersRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParsersRequest.java
new file mode 100644
index 000000000..747a648a5
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParsersRequest.java
@@ -0,0 +1,88 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 ListBuiltinParsersRequest {
+ /**
+ * AIP-160 filter expression. Built-ins are filterable by their `tags`; the exact tag-filter
+ * grammar is defined by the server.
+ */
+ @JsonIgnore
+ @QueryParam("filter")
+ private String filter;
+
+ /**
+ * Maximum number of results to return in one page. This is a best-effort upper bound, not a
+ * guarantee: the server may return fewer items than requested (even zero) while more results
+ * still exist. If unset or 0, the server picks a default.
+ */
+ @JsonIgnore
+ @QueryParam("page_size")
+ private Long pageSize;
+
+ /**
+ * Page token from a previous `ListBuiltinParsers` response, used to fetch the next page of
+ * results.
+ */
+ @JsonIgnore
+ @QueryParam("page_token")
+ private String pageToken;
+
+ public ListBuiltinParsersRequest setFilter(String filter) {
+ this.filter = filter;
+ return this;
+ }
+
+ public String getFilter() {
+ return filter;
+ }
+
+ public ListBuiltinParsersRequest setPageSize(Long pageSize) {
+ this.pageSize = pageSize;
+ return this;
+ }
+
+ public Long getPageSize() {
+ return pageSize;
+ }
+
+ public ListBuiltinParsersRequest setPageToken(String pageToken) {
+ this.pageToken = pageToken;
+ return this;
+ }
+
+ public String getPageToken() {
+ return pageToken;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListBuiltinParsersRequest that = (ListBuiltinParsersRequest) o;
+ return Objects.equals(filter, that.filter)
+ && Objects.equals(pageSize, that.pageSize)
+ && Objects.equals(pageToken, that.pageToken);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(filter, pageSize, pageToken);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListBuiltinParsersRequest.class)
+ .add("filter", filter)
+ .add("pageSize", pageSize)
+ .add("pageToken", pageToken)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParsersResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParsersResponse.java
new file mode 100644
index 000000000..4addc84fd
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListBuiltinParsersResponse.java
@@ -0,0 +1,69 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Collection;
+import java.util.Objects;
+
+/** A page of built-in parsers, without their specs. */
+@Generated
+public class ListBuiltinParsersResponse {
+ /**
+ * Summary rows: the container fields only, without the spec. Read a spec with
+ * `GetBuiltinParserVersion`.
+ */
+ @JsonProperty("builtin_parsers")
+ private Collection builtinParsers;
+
+ /**
+ * Opaque token for fetching the next page; pass it as `page_token` on the next call. It is empty
+ * only when there are no more results. Page size is best-effort, so a short or even empty page
+ * does not mean the end; keep paging until this token is empty, which is the only reliable
+ * end-of-results signal.
+ */
+ @JsonProperty("next_page_token")
+ private String nextPageToken;
+
+ public ListBuiltinParsersResponse setBuiltinParsers(Collection builtinParsers) {
+ this.builtinParsers = builtinParsers;
+ return this;
+ }
+
+ public Collection getBuiltinParsers() {
+ return builtinParsers;
+ }
+
+ public ListBuiltinParsersResponse setNextPageToken(String nextPageToken) {
+ this.nextPageToken = nextPageToken;
+ return this;
+ }
+
+ public String getNextPageToken() {
+ return nextPageToken;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListBuiltinParsersResponse that = (ListBuiltinParsersResponse) o;
+ return Objects.equals(builtinParsers, that.builtinParsers)
+ && Objects.equals(nextPageToken, that.nextPageToken);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(builtinParsers, nextPageToken);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListBuiltinParsersResponse.class)
+ .add("builtinParsers", builtinParsers)
+ .add("nextPageToken", nextPageToken)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParserVersionsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParserVersionsRequest.java
new file mode 100644
index 000000000..f9ad14221
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParserVersionsRequest.java
@@ -0,0 +1,84 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 ListParserVersionsRequest {
+ /**
+ * Maximum number of results to return in one page. This is a best-effort upper bound, not a
+ * guarantee: the server may return fewer items than requested (even zero) while more results
+ * still exist. If unset or 0, the server picks a default.
+ */
+ @JsonIgnore
+ @QueryParam("page_size")
+ private Long pageSize;
+
+ /**
+ * Page token from a previous `ListParserVersions` response, used to fetch the next page of
+ * results. Send the same `parent` when requesting later pages; a token from a request for a
+ * different parser is rejected.
+ */
+ @JsonIgnore
+ @QueryParam("page_token")
+ private String pageToken;
+
+ /** Resource name of the parser whose versions are listed. Format: `parsers/{parser_id}`. */
+ @JsonIgnore private String parent;
+
+ public ListParserVersionsRequest setPageSize(Long pageSize) {
+ this.pageSize = pageSize;
+ return this;
+ }
+
+ public Long getPageSize() {
+ return pageSize;
+ }
+
+ public ListParserVersionsRequest setPageToken(String pageToken) {
+ this.pageToken = pageToken;
+ return this;
+ }
+
+ public String getPageToken() {
+ return pageToken;
+ }
+
+ public ListParserVersionsRequest setParent(String parent) {
+ this.parent = parent;
+ return this;
+ }
+
+ public String getParent() {
+ return parent;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListParserVersionsRequest that = (ListParserVersionsRequest) o;
+ return Objects.equals(pageSize, that.pageSize)
+ && Objects.equals(pageToken, that.pageToken)
+ && Objects.equals(parent, that.parent);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(pageSize, pageToken, parent);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListParserVersionsRequest.class)
+ .add("pageSize", pageSize)
+ .add("pageToken", pageToken)
+ .add("parent", parent)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParserVersionsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParserVersionsResponse.java
new file mode 100644
index 000000000..01be50412
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParserVersionsResponse.java
@@ -0,0 +1,69 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Collection;
+import java.util.Objects;
+
+/** A page of version metadata, without the specs. */
+@Generated
+public class ListParserVersionsResponse {
+ /**
+ * Opaque token for fetching the next page; pass it as `page_token` on the next call. It is empty
+ * only when there are no more results. Page size is best-effort, so a short or even empty page
+ * does not mean the end; keep paging until this token is empty, which is the only reliable
+ * end-of-results signal.
+ */
+ @JsonProperty("next_page_token")
+ private String nextPageToken;
+
+ /**
+ * Version metadata only, oldest first, without the spec. Each row's `create_time` and
+ * `created_by` are that version's own.
+ */
+ @JsonProperty("parser_versions")
+ private Collection parserVersions;
+
+ public ListParserVersionsResponse setNextPageToken(String nextPageToken) {
+ this.nextPageToken = nextPageToken;
+ return this;
+ }
+
+ public String getNextPageToken() {
+ return nextPageToken;
+ }
+
+ public ListParserVersionsResponse setParserVersions(Collection parserVersions) {
+ this.parserVersions = parserVersions;
+ return this;
+ }
+
+ public Collection getParserVersions() {
+ return parserVersions;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListParserVersionsResponse that = (ListParserVersionsResponse) o;
+ return Objects.equals(nextPageToken, that.nextPageToken)
+ && Objects.equals(parserVersions, that.parserVersions);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(nextPageToken, parserVersions);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListParserVersionsResponse.class)
+ .add("nextPageToken", nextPageToken)
+ .add("parserVersions", parserVersions)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParsersRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParsersRequest.java
new file mode 100644
index 000000000..fd470a34d
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParsersRequest.java
@@ -0,0 +1,125 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+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 ListParsersRequest {
+ /**
+ * Name of the parent UC catalog to list parsers from. Required: List is scoped to a single
+ * catalog, mirroring the Unity Catalog tables/functions APIs, which take catalog_name as a
+ * request field (bound to a query parameter) rather than a catalog path segment.
+ */
+ @JsonIgnore
+ @QueryParam("catalog_name")
+ private String catalogName;
+
+ /** AIP-160 filter expression. Parsers are filterable by `parser_name`. */
+ @JsonIgnore
+ @QueryParam("filter")
+ private String filter;
+
+ /**
+ * Maximum number of results to return in one page. This is a best-effort upper bound, not a
+ * guarantee: the server may return fewer items than requested (even zero) while more results
+ * still exist. If unset or 0, the server picks a default.
+ */
+ @JsonIgnore
+ @QueryParam("page_size")
+ private Long pageSize;
+
+ /**
+ * Page token from a previous `ListParsers` response, used to fetch the next page of results. Send
+ * the other request fields unchanged when requesting later pages; a token from a request with
+ * different fields is rejected.
+ */
+ @JsonIgnore
+ @QueryParam("page_token")
+ private String pageToken;
+
+ /**
+ * Name of the parent UC schema. Optional: when set, results are narrowed to this schema; when
+ * omitted, parsers across all schemas in `catalog_name` are returned.
+ */
+ @JsonIgnore
+ @QueryParam("schema_name")
+ private String schemaName;
+
+ public ListParsersRequest setCatalogName(String catalogName) {
+ this.catalogName = catalogName;
+ return this;
+ }
+
+ public String getCatalogName() {
+ return catalogName;
+ }
+
+ public ListParsersRequest setFilter(String filter) {
+ this.filter = filter;
+ return this;
+ }
+
+ public String getFilter() {
+ return filter;
+ }
+
+ public ListParsersRequest setPageSize(Long pageSize) {
+ this.pageSize = pageSize;
+ return this;
+ }
+
+ public Long getPageSize() {
+ return pageSize;
+ }
+
+ public ListParsersRequest setPageToken(String pageToken) {
+ this.pageToken = pageToken;
+ return this;
+ }
+
+ public String getPageToken() {
+ return pageToken;
+ }
+
+ public ListParsersRequest setSchemaName(String schemaName) {
+ this.schemaName = schemaName;
+ return this;
+ }
+
+ public String getSchemaName() {
+ return schemaName;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListParsersRequest that = (ListParsersRequest) o;
+ return Objects.equals(catalogName, that.catalogName)
+ && Objects.equals(filter, that.filter)
+ && Objects.equals(pageSize, that.pageSize)
+ && Objects.equals(pageToken, that.pageToken)
+ && Objects.equals(schemaName, that.schemaName);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(catalogName, filter, pageSize, pageToken, schemaName);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListParsersRequest.class)
+ .add("catalogName", catalogName)
+ .add("filter", filter)
+ .add("pageSize", pageSize)
+ .add("pageToken", pageToken)
+ .add("schemaName", schemaName)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParsersResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParsersResponse.java
new file mode 100644
index 000000000..73c4b1fe1
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ListParsersResponse.java
@@ -0,0 +1,68 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Collection;
+import java.util.Objects;
+
+/** A page of parsers, without their specs. */
+@Generated
+public class ListParsersResponse {
+ /**
+ * Opaque token for fetching the next page; pass it as `page_token` on the next call. It is empty
+ * only when there are no more results. Page size is best-effort, so a short or even empty page
+ * does not mean the end; keep paging until this token is empty, which is the only reliable
+ * end-of-results signal.
+ */
+ @JsonProperty("next_page_token")
+ private String nextPageToken;
+
+ /**
+ * Summary rows: the container fields only, without the spec. Read a spec with `GetParserVersion`.
+ */
+ @JsonProperty("parsers")
+ private Collection parsers;
+
+ public ListParsersResponse setNextPageToken(String nextPageToken) {
+ this.nextPageToken = nextPageToken;
+ return this;
+ }
+
+ public String getNextPageToken() {
+ return nextPageToken;
+ }
+
+ public ListParsersResponse setParsers(Collection parsers) {
+ this.parsers = parsers;
+ return this;
+ }
+
+ public Collection getParsers() {
+ return parsers;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ListParsersResponse that = (ListParsersResponse) o;
+ return Objects.equals(nextPageToken, that.nextPageToken)
+ && Objects.equals(parsers, that.parsers);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(nextPageToken, parsers);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ListParsersResponse.class)
+ .add("nextPageToken", nextPageToken)
+ .add("parsers", parsers)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Parser.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Parser.java
new file mode 100644
index 000000000..f4efa4502
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/Parser.java
@@ -0,0 +1,279 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.google.protobuf.Timestamp;
+import java.util.Objects;
+
+/**
+ * A customer-authored, versioned contract describing the fields of an ingested log source.
+ *
+ * The parser is a container: it carries the identity and a pointer to the newest version. Specs
+ * live on the immutable `ParserVersion` children, so one parser can be attached to many data
+ * sources and each attachment pins a version.
+ */
+@Generated
+public class Parser {
+ /**
+ * Name of the parent UC catalog, set on create. Reads return the value as supplied; the current
+ * UC catalog name is reported in `effective_catalog_name`.
+ */
+ @JsonProperty("catalog_name")
+ private String catalogName;
+
+ /** When the parser was created. */
+ @JsonProperty("create_time")
+ private Timestamp createTime;
+
+ /** The principal that created this parser. Each version records its own `created_by`. */
+ @JsonProperty("created_by")
+ private Principal createdBy;
+
+ /**
+ * Description of version 1. Accepted only by `CreateParser`; read a version's description with
+ * `GetParserVersion`.
+ */
+ @JsonProperty("description")
+ private String description;
+
+ /**
+ * The current name of the parser's UC catalog. Tracks UC renames; when the current name cannot be
+ * looked up, the name as of the parser's last write.
+ */
+ @JsonProperty("effective_catalog_name")
+ private String effectiveCatalogName;
+
+ /**
+ * The current name of the parser's UC schema. Tracks UC renames; when the current name cannot be
+ * looked up, the name as of the parser's last write.
+ */
+ @JsonProperty("effective_schema_name")
+ private String effectiveSchemaName;
+
+ /**
+ * Newest version of this parser. Read its spec by passing this to `GetParserVersion`, or by using
+ * the `latest` alias. Absent when every version has been deleted.
+ */
+ @JsonProperty("latest_version")
+ private Long latestVersion;
+
+ /**
+ * Resource name. Format: `parsers/{parser_id}`, where the leaf is the immutable server-assigned
+ * UUID. Create-time placement names are stored separately and do not affect the resource name.
+ */
+ @JsonProperty("name")
+ private String name;
+
+ /**
+ * The principal that owns this parser. Server-set from the authenticated creator, never supplied
+ * by the client. Beta reads by UUID perform no authorization. Owner-gated write RPCs are outside
+ * this API's current implementation scope.
+ */
+ @JsonProperty("owner")
+ private Principal owner;
+
+ /**
+ * The parser's server-assigned UUID. It is not currently a UC securable ID, is immutable for the
+ * life of the resource, is the leaf of `name`, and is returned by CreateParser.
+ */
+ @JsonProperty("parser_id")
+ private String parserId;
+
+ /**
+ * Client-supplied parser name, stored as supplied and fixed at create time. Must be a valid UC
+ * identifier. A custom parser is not currently a UC securable and this field has no rename path.
+ */
+ @JsonProperty("parser_name")
+ private String parserName;
+
+ /**
+ * Name of the parent UC schema, set on create. Reads return the value as supplied; the current UC
+ * schema name is reported in `effective_schema_name`.
+ */
+ @JsonProperty("schema_name")
+ private String schemaName;
+
+ /**
+ * Spec of version 1, as a YAML document. Accepted only by `CreateParser`; read a version's spec
+ * with `GetParserVersion`.
+ */
+ @JsonProperty("spec")
+ private String spec;
+
+ public Parser setCatalogName(String catalogName) {
+ this.catalogName = catalogName;
+ return this;
+ }
+
+ public String getCatalogName() {
+ return catalogName;
+ }
+
+ public Parser setCreateTime(Timestamp createTime) {
+ this.createTime = createTime;
+ return this;
+ }
+
+ public Timestamp getCreateTime() {
+ return createTime;
+ }
+
+ public Parser setCreatedBy(Principal createdBy) {
+ this.createdBy = createdBy;
+ return this;
+ }
+
+ public Principal getCreatedBy() {
+ return createdBy;
+ }
+
+ public Parser setDescription(String description) {
+ this.description = description;
+ return this;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public Parser setEffectiveCatalogName(String effectiveCatalogName) {
+ this.effectiveCatalogName = effectiveCatalogName;
+ return this;
+ }
+
+ public String getEffectiveCatalogName() {
+ return effectiveCatalogName;
+ }
+
+ public Parser setEffectiveSchemaName(String effectiveSchemaName) {
+ this.effectiveSchemaName = effectiveSchemaName;
+ return this;
+ }
+
+ public String getEffectiveSchemaName() {
+ return effectiveSchemaName;
+ }
+
+ public Parser setLatestVersion(Long latestVersion) {
+ this.latestVersion = latestVersion;
+ return this;
+ }
+
+ public Long getLatestVersion() {
+ return latestVersion;
+ }
+
+ public Parser setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public Parser setOwner(Principal owner) {
+ this.owner = owner;
+ return this;
+ }
+
+ public Principal getOwner() {
+ return owner;
+ }
+
+ public Parser setParserId(String parserId) {
+ this.parserId = parserId;
+ return this;
+ }
+
+ public String getParserId() {
+ return parserId;
+ }
+
+ public Parser setParserName(String parserName) {
+ this.parserName = parserName;
+ return this;
+ }
+
+ public String getParserName() {
+ return parserName;
+ }
+
+ public Parser setSchemaName(String schemaName) {
+ this.schemaName = schemaName;
+ return this;
+ }
+
+ public String getSchemaName() {
+ return schemaName;
+ }
+
+ public Parser setSpec(String spec) {
+ this.spec = spec;
+ return this;
+ }
+
+ public String getSpec() {
+ return spec;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ Parser that = (Parser) o;
+ return Objects.equals(catalogName, that.catalogName)
+ && Objects.equals(createTime, that.createTime)
+ && Objects.equals(createdBy, that.createdBy)
+ && Objects.equals(description, that.description)
+ && Objects.equals(effectiveCatalogName, that.effectiveCatalogName)
+ && Objects.equals(effectiveSchemaName, that.effectiveSchemaName)
+ && Objects.equals(latestVersion, that.latestVersion)
+ && Objects.equals(name, that.name)
+ && Objects.equals(owner, that.owner)
+ && Objects.equals(parserId, that.parserId)
+ && Objects.equals(parserName, that.parserName)
+ && Objects.equals(schemaName, that.schemaName)
+ && Objects.equals(spec, that.spec);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(
+ catalogName,
+ createTime,
+ createdBy,
+ description,
+ effectiveCatalogName,
+ effectiveSchemaName,
+ latestVersion,
+ name,
+ owner,
+ parserId,
+ parserName,
+ schemaName,
+ spec);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(Parser.class)
+ .add("catalogName", catalogName)
+ .add("createTime", createTime)
+ .add("createdBy", createdBy)
+ .add("description", description)
+ .add("effectiveCatalogName", effectiveCatalogName)
+ .add("effectiveSchemaName", effectiveSchemaName)
+ .add("latestVersion", latestVersion)
+ .add("name", name)
+ .add("owner", owner)
+ .add("parserId", parserId)
+ .add("parserName", parserName)
+ .add("schemaName", schemaName)
+ .add("spec", spec)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ParserTag.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ParserTag.java
new file mode 100644
index 000000000..db66e53e2
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ParserTag.java
@@ -0,0 +1,63 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+/**
+ * A key/value tag on a built-in parser, e.g. `key = "cloud_provider"`, `value = "aws"`. Key/value
+ * pairs match the tag shape used across Databricks (MLflow, model-serving endpoints, clusters)
+ * rather than a bare string list.
+ */
+@Generated
+public class ParserTag {
+ /**
+ * The tag key, e.g. `cloud_provider`. Required: a keyless tag cannot be filtered on and is
+ * meaningless.
+ */
+ @JsonProperty("key")
+ private String key;
+
+ /** The tag value, e.g. `aws`. */
+ @JsonProperty("value")
+ private String value;
+
+ public ParserTag setKey(String key) {
+ this.key = key;
+ return this;
+ }
+
+ public String getKey() {
+ return key;
+ }
+
+ public ParserTag setValue(String value) {
+ this.value = value;
+ return this;
+ }
+
+ public String getValue() {
+ return value;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ParserTag that = (ParserTag) o;
+ return Objects.equals(key, that.key) && Objects.equals(value, that.value);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(key, value);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ParserTag.class).add("key", key).add("value", value).toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ParserVersion.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ParserVersion.java
new file mode 100644
index 000000000..c671bb03d
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/lakewatch/ParserVersion.java
@@ -0,0 +1,149 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.lakewatch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.google.protobuf.Timestamp;
+import java.util.Objects;
+
+/**
+ * One immutable version of a parser, carrying the spec.
+ *
+ *
Immutable: an edit creates a new version rather than mutating an existing one, so a data
+ * source that pins a version is never affected. Version numbers are never reused, including after a
+ * delete.
+ */
+@Generated
+public class ParserVersion {
+ /** When this version was appended. */
+ @JsonProperty("create_time")
+ private Timestamp createTime;
+
+ /** The principal that appended this version. */
+ @JsonProperty("created_by")
+ private Principal createdBy;
+
+ /** Free-form description of this version, set when the version is created. */
+ @JsonProperty("description")
+ private String description;
+
+ /** Resource name. Format: `parsers/{parser_id}/versions/{version}`. */
+ @JsonProperty("name")
+ private String name;
+
+ /**
+ * The parent parser's name, copied from the container on read. Denormalized so a caller that
+ * needs identity alongside the spec reads the version alone rather than the container as well.
+ * Populated by `GetParserVersion`; List omits it, as List omits `spec`.
+ */
+ @JsonProperty("parser_name")
+ private String parserName;
+
+ /**
+ * The field definitions for this log source, as a YAML document. Validated on write, so an
+ * invalid spec is never stored.
+ */
+ @JsonProperty("spec")
+ private String spec;
+
+ /** Version number, assigned by the server when the version is appended. */
+ @JsonProperty("version")
+ private Long version;
+
+ public ParserVersion setCreateTime(Timestamp createTime) {
+ this.createTime = createTime;
+ return this;
+ }
+
+ public Timestamp getCreateTime() {
+ return createTime;
+ }
+
+ public ParserVersion setCreatedBy(Principal createdBy) {
+ this.createdBy = createdBy;
+ return this;
+ }
+
+ public Principal getCreatedBy() {
+ return createdBy;
+ }
+
+ public ParserVersion setDescription(String description) {
+ this.description = description;
+ return this;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public ParserVersion setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public ParserVersion setParserName(String parserName) {
+ this.parserName = parserName;
+ return this;
+ }
+
+ public String getParserName() {
+ return parserName;
+ }
+
+ public ParserVersion setSpec(String spec) {
+ this.spec = spec;
+ return this;
+ }
+
+ public String getSpec() {
+ return spec;
+ }
+
+ public ParserVersion setVersion(Long version) {
+ this.version = version;
+ return this;
+ }
+
+ public Long getVersion() {
+ return version;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ ParserVersion that = (ParserVersion) o;
+ return Objects.equals(createTime, that.createTime)
+ && Objects.equals(createdBy, that.createdBy)
+ && Objects.equals(description, that.description)
+ && Objects.equals(name, that.name)
+ && Objects.equals(parserName, that.parserName)
+ && Objects.equals(spec, that.spec)
+ && Objects.equals(version, that.version);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(createTime, createdBy, description, name, parserName, spec, version);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(ParserVersion.class)
+ .add("createTime", createTime)
+ .add("createdBy", createdBy)
+ .add("description", description)
+ .add("name", name)
+ .add("parserName", parserName)
+ .add("spec", spec)
+ .add("version", version)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateExperiment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateExperiment.java
index 9197ea2ab..2e6d6e467 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateExperiment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateExperiment.java
@@ -11,21 +11,24 @@
@Generated
public class CreateExperiment {
/**
- * Location where all artifacts for the experiment are stored. If not provided, the remote server
- * will select an appropriate default.
+ * URI of the location where the artifacts of the experiment's runs are stored, such as a Unity
+ * Catalog volume path of the form `dbfs:/Volumes////`. The URI
+ * must have a scheme other than `file` and must not point under the MLflow-managed prefix
+ * `dbfs:/databricks/mlflow-tracking`. If omitted, artifacts are stored in MLflow-managed storage.
+ * See https://docs.databricks.com/aws/en/mlflow/experiments for the supported locations.
*/
@JsonProperty("artifact_location")
private String artifactLocation;
- /** Experiment name. */
+ /**
+ * Name of the experiment, as an absolute path in the workspace. Experiments cannot be created
+ * under `/Repos`.
+ */
@JsonProperty("name")
private String name;
/**
- * A collection of tags to set on the experiment. Maximum tag size and number of tags per request
- * depends on the storage backend. All storage backends are guaranteed to support tag keys up to
- * 250 bytes in size and tag values up to 5000 bytes in size. All storage backends are also
- * guaranteed to support up to 20 tags per request.
+ * Tags to set on the new experiment, as key-value pairs. A request can include at most 100 tags.
*/
@JsonProperty("tags")
private Collection tags;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionRequest.java
index 6e59fd63b..b7c8d29c2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionRequest.java
@@ -10,17 +10,17 @@
@Generated
public class CreateModelVersionRequest {
- /** Optional description for model version. */
+ /** Description of the model version. */
@JsonProperty("description")
private String description;
- /** Register model under this name */
+ /** Name of the existing registered model to create the version under. */
@JsonProperty("name")
private String name;
/**
- * MLflow run ID for correlation, if `source` was generated by an experiment run in MLflow
- * tracking server
+ * ID of the MLflow run that produced the model artifacts, if `source` comes from a run in the
+ * MLflow tracking server. The ID is at most 32 characters long.
*/
@JsonProperty("run_id")
private String runId;
@@ -32,11 +32,15 @@ public class CreateModelVersionRequest {
@JsonProperty("run_link")
private String runLink;
- /** URI indicating the location of the model artifacts. */
+ /**
+ * URI of the model artifacts to register, such as the artifact path of an MLflow run or a
+ * `models://` URI of an existing `READY` model version. The registry copies
+ * the artifacts asynchronously, so the new version starts in `PENDING_REGISTRATION` status.
+ */
@JsonProperty("source")
private String source;
- /** Additional metadata for model version. */
+ /** Tags to set on the new model version. */
@JsonProperty("tags")
private Collection tags;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionResponse.java
index 4f6749858..be872b1b4 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/CreateModelVersionResponse.java
@@ -9,7 +9,7 @@
@Generated
public class CreateModelVersionResponse {
- /** Return new version number generated for this model in registry. */
+ /** The new model version, including the version number that the registry assigned. */
@JsonProperty("model_version")
private ModelVersion modelVersion;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Experiment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Experiment.java
index aba3e2783..8ecf2c579 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Experiment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/Experiment.java
@@ -11,11 +11,15 @@
/** An experiment and its metadata. */
@Generated
public class Experiment {
- /** Location where artifacts for the experiment are stored. */
+ /**
+ * URI of the location where the artifacts of the experiment's runs are stored. Experiments
+ * created without an explicit location use MLflow-managed storage under
+ * `dbfs:/databricks/mlflow-tracking/`.
+ */
@JsonProperty("artifact_location")
private String artifactLocation;
- /** Creation time */
+ /** Time when the experiment was created, as a Unix timestamp in milliseconds. */
@JsonProperty("creation_time")
private Long creationTime;
@@ -23,22 +27,29 @@ public class Experiment {
@JsonProperty("experiment_id")
private String experimentId;
- /** Last update time */
+ /** Time when the experiment metadata was last updated, as a Unix timestamp in milliseconds. */
@JsonProperty("last_update_time")
private Long lastUpdateTime;
/**
- * Current life cycle stage of the experiment: "active" or "deleted". Deleted experiments are not
- * returned by APIs.
+ * Current life cycle stage of the experiment: `active` or `deleted`. Deleted experiments are
+ * excluded from list and search results unless `view_type` requests them, and can be restored
+ * until they are permanently deleted.
*/
@JsonProperty("lifecycle_stage")
private String lifecycleStage;
- /** Human readable name that identifies the experiment. */
+ /**
+ * Name of the experiment. A workspace experiment is named by its absolute path in the workspace;
+ * a notebook experiment has the path of its notebook.
+ */
@JsonProperty("name")
private String name;
- /** Tags: Additional metadata key-value pairs. */
+ /**
+ * Tags set on the experiment, as key-value pairs, including system tags such as `mlflow.ownerId`
+ * that MLflow maintains.
+ */
@JsonProperty("tags")
private Collection tags;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentTag.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentTag.java
index 125870ff3..1e1341a69 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentTag.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentTag.java
@@ -10,11 +10,11 @@
/** A tag for an experiment. */
@Generated
public class ExperimentTag {
- /** The tag key. */
+ /** The tag key. Keys are at most 255 characters long. */
@JsonProperty("key")
private String key;
- /** The tag value. */
+ /** The tag value. Values are at most 65535 characters long. */
@JsonProperty("value")
private String value;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsAPI.java
index b962771e2..99c99915d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsAPI.java
@@ -66,7 +66,8 @@ public CreateRunResponse createRun(CreateRun request) {
/**
* Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion. If
- * the experiment uses FileStore, artifacts associated with the experiment are also deleted.
+ * the experiment uses FileStore, artifacts associated with the experiment are also deleted. Only
+ * workspace experiments can be deleted through this method.
*/
public void deleteExperiment(DeleteExperiment request) {
impl.deleteExperiment(request);
@@ -238,7 +239,7 @@ public Iterable listArtifacts(ListArtifactsRequest request) {
});
}
- /** Gets a list of all experiments. */
+ /** Gets a list of all experiments, ordered by creation time with the newest first. */
public Iterable listExperiments(ListExperimentsRequest request) {
return Paginator.newTokenPagination(
request,
@@ -354,6 +355,8 @@ public void logParam(LogParam request) {
* metrics, params, and tags. If experiment uses FileStore, underlying artifacts associated with
* experiment are also restored.
*
+ * Only workspace experiments can be restored through this method.
+ *
*
Throws `RESOURCE_DOES_NOT_EXIST` if experiment was never created or was permanently deleted.
*/
public void restoreExperiment(RestoreExperiment request) {
@@ -459,7 +462,10 @@ public void setTag(SetTag request) {
impl.setTag(request);
}
- /** Updates experiment metadata. */
+ /**
+ * Updates experiment metadata. Only workspace experiments can be updated; a notebook experiment
+ * takes its name from its notebook.
+ */
public void updateExperiment(UpdateExperiment request) {
impl.updateExperiment(request);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsService.java
index c475cddfe..611b4dfce 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ExperimentsService.java
@@ -44,7 +44,8 @@ public interface ExperimentsService {
/**
* Marks an experiment and associated metadata, runs, metrics, params, and tags for deletion. If
- * the experiment uses FileStore, artifacts associated with the experiment are also deleted.
+ * the experiment uses FileStore, artifacts associated with the experiment are also deleted. Only
+ * workspace experiments can be deleted through this method.
*/
void deleteExperiment(DeleteExperiment deleteExperiment);
@@ -125,7 +126,7 @@ ExperimentPermissions getPermissions(
*/
ListArtifactsResponse listArtifacts(ListArtifactsRequest listArtifactsRequest);
- /** Gets a list of all experiments. */
+ /** Gets a list of all experiments, ordered by creation time with the newest first. */
ListExperimentsResponse listExperiments(ListExperimentsRequest listExperimentsRequest);
/**
@@ -215,6 +216,8 @@ ExperimentPermissions getPermissions(
* metrics, params, and tags. If experiment uses FileStore, underlying artifacts associated with
* experiment are also restored.
*
+ *
Only workspace experiments can be restored through this method.
+ *
*
Throws `RESOURCE_DOES_NOT_EXIST` if experiment was never created or was permanently deleted.
*/
void restoreExperiment(RestoreExperiment restoreExperiment);
@@ -269,7 +272,10 @@ SearchLoggedModelsResponse searchLoggedModels(
*/
void setTag(SetTag setTag);
- /** Updates experiment metadata. */
+ /**
+ * Updates experiment metadata. Only workspace experiments can be updated; a notebook experiment
+ * takes its name from its notebook.
+ */
void updateExperiment(UpdateExperiment updateExperiment);
/** Updates the fields of an issue named in `update_mask`. */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ListExperimentsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ListExperimentsRequest.java
index 6b50ba2bd..1ab01bdca 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ListExperimentsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ListExperimentsRequest.java
@@ -20,7 +20,9 @@ public class ListExperimentsRequest {
@QueryParam("max_results")
private Long maxResults;
- /** Token indicating the page of experiments to fetch */
+ /**
+ * Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.
+ */
@JsonIgnore
@QueryParam("page_token")
private String pageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/MaterializedFeature.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/MaterializedFeature.java
index ac65bcb03..337c958f5 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/MaterializedFeature.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/MaterializedFeature.java
@@ -97,6 +97,10 @@ public class MaterializedFeature {
@JsonProperty("online_store_config")
private OnlineStoreConfig onlineStoreConfig;
+ /** Operations associated with this materialized feature. */
+ @JsonProperty("operations")
+ private MaterializedFeatureOperations operations;
+
/**
* The ID of the pipeline that materializes this feature. This is only present for streaming
* features.
@@ -265,6 +269,15 @@ public OnlineStoreConfig getOnlineStoreConfig() {
return onlineStoreConfig;
}
+ public MaterializedFeature setOperations(MaterializedFeatureOperations operations) {
+ this.operations = operations;
+ return this;
+ }
+
+ public MaterializedFeatureOperations getOperations() {
+ return operations;
+ }
+
public MaterializedFeature setPipelineId(String pipelineId) {
this.pipelineId = pipelineId;
return this;
@@ -339,6 +352,7 @@ public boolean equals(Object o) {
&& Objects.equals(notifications, that.notifications)
&& Objects.equals(offlineStoreConfig, that.offlineStoreConfig)
&& Objects.equals(onlineStoreConfig, that.onlineStoreConfig)
+ && Objects.equals(operations, that.operations)
&& Objects.equals(pipelineId, that.pipelineId)
&& Objects.equals(pipelineScheduleState, that.pipelineScheduleState)
&& Objects.equals(streamingMode, that.streamingMode)
@@ -364,6 +378,7 @@ public int hashCode() {
notifications,
offlineStoreConfig,
onlineStoreConfig,
+ operations,
pipelineId,
pipelineScheduleState,
streamingMode,
@@ -389,6 +404,7 @@ public String toString() {
.add("notifications", notifications)
.add("offlineStoreConfig", offlineStoreConfig)
.add("onlineStoreConfig", onlineStoreConfig)
+ .add("operations", operations)
.add("pipelineId", pipelineId)
.add("pipelineScheduleState", pipelineScheduleState)
.add("streamingMode", streamingMode)
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/MaterializedFeatureOperations.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/MaterializedFeatureOperations.java
new file mode 100644
index 000000000..71ab71fd7
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/MaterializedFeatureOperations.java
@@ -0,0 +1,46 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.ml;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+/** References to operations on a materialized feature. */
+@Generated
+public class MaterializedFeatureOperations {
+ /** Name of the latest entity purge operation. Format: operations/{operation_id}. */
+ @JsonProperty("latest_entity_purge_operation")
+ private String latestEntityPurgeOperation;
+
+ public MaterializedFeatureOperations setLatestEntityPurgeOperation(
+ String latestEntityPurgeOperation) {
+ this.latestEntityPurgeOperation = latestEntityPurgeOperation;
+ return this;
+ }
+
+ public String getLatestEntityPurgeOperation() {
+ return latestEntityPurgeOperation;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ MaterializedFeatureOperations that = (MaterializedFeatureOperations) o;
+ return Objects.equals(latestEntityPurgeOperation, that.latestEntityPurgeOperation);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(latestEntityPurgeOperation);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(MaterializedFeatureOperations.class)
+ .add("latestEntityPurgeOperation", latestEntityPurgeOperation)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryAPI.java
index e11d5c861..633b46853 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryAPI.java
@@ -338,7 +338,7 @@ public UpdateModelResponse updateModel(UpdateModelRequest request) {
return impl.updateModel(request);
}
- /** Updates the model version. */
+ /** Updates the description of a model version. */
public UpdateModelVersionResponse updateModelVersion(UpdateModelVersionRequest request) {
return impl.updateModelVersion(request);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryService.java
index 416afd402..445fa5543 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelRegistryService.java
@@ -155,7 +155,7 @@ TransitionStageResponse transitionStage(
/** Updates a registered model. */
UpdateModelResponse updateModel(UpdateModelRequest updateModelRequest);
- /** Updates the model version. */
+ /** Updates the description of a model version. */
UpdateModelVersionResponse updateModelVersion(
UpdateModelVersionRequest updateModelVersionRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersion.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersion.java
index 588ad0492..9189de5b8 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersion.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersion.java
@@ -8,54 +8,71 @@
import java.util.Collection;
import java.util.Objects;
+/**
+ * A version of a registered model in the Workspace Model Registry. Each version points to the model
+ * artifacts it was registered from and moves through the stages `None`, `Staging`, `Production` and
+ * `Archived`.
+ */
@Generated
public class ModelVersion {
- /** Timestamp recorded when this `model_version` was created. */
+ /** Time when the model version was created, as a Unix timestamp in milliseconds. */
@JsonProperty("creation_timestamp")
private Long creationTimestamp;
- /** Current stage for this `model_version`. */
+ /**
+ * Current stage of the model version. Valid values are `None`, `Staging`, `Production` and
+ * `Archived`. A new model version starts in `None`.
+ */
@JsonProperty("current_stage")
private String currentStage;
- /** Description of this `model_version`. */
+ /** User-provided description of the model version. */
@JsonProperty("description")
private String description;
- /** Timestamp recorded when metadata for this `model_version` was last updated. */
+ /**
+ * Time when the metadata of the model version was last updated, as a Unix timestamp in
+ * milliseconds.
+ */
@JsonProperty("last_updated_timestamp")
private Long lastUpdatedTimestamp;
- /** Unique name of the model */
+ /** Name of the registered model that the version belongs to. */
@JsonProperty("name")
private String name;
/**
- * MLflow run ID used when creating `model_version`, if `source` was generated by an experiment
- * run stored in MLflow tracking server.
+ * ID of the MLflow run that produced the model artifacts, if `source` comes from a run in the
+ * MLflow tracking server.
*/
@JsonProperty("run_id")
private String runId;
- /** Run Link: Direct link to the run that generated this version */
+ /**
+ * URL of the MLflow run that generated the model version, as given in the create request. It is
+ * typically set when the run is hosted on a different tracking server than the registry.
+ */
@JsonProperty("run_link")
private String runLink;
/**
- * URI indicating the location of the source model artifacts, used when creating `model_version`
+ * URI of the model artifacts that the model version was registered from, as given in the create
+ * request.
*/
@JsonProperty("source")
private String source;
- /** Current status of `model_version` */
+ /**
+ * Registration status of the model version. The version can be used once the status is `READY`.
+ */
@JsonProperty("status")
private ModelVersionStatus status;
- /** Details on current `status`, if it is pending or failed. */
+ /** Details on the current `status`, such as the reason why registration failed. */
@JsonProperty("status_message")
private String statusMessage;
- /** Tags: Additional metadata key-value pairs for this `model_version`. */
+ /** Key-value tags attached to the model version. */
@JsonProperty("tags")
private Collection tags;
@@ -63,7 +80,10 @@ public class ModelVersion {
@JsonProperty("user_id")
private String userId;
- /** Model's version number. */
+ /**
+ * Version number of the model version, as a string. Version numbers start at 1 for each
+ * registered model.
+ */
@JsonProperty("version")
private String version;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersionDatabricks.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersionDatabricks.java
index b11b61291..1ea0cace2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersionDatabricks.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/ModelVersionDatabricks.java
@@ -14,7 +14,10 @@ public class ModelVersionDatabricks {
@JsonProperty("creation_timestamp")
private Long creationTimestamp;
- /** */
+ /**
+ * Current stage of the model version. Valid values are `None`, `Staging`, `Production` and
+ * `Archived`.
+ */
@JsonProperty("current_stage")
private String currentStage;
@@ -41,14 +44,13 @@ public class ModelVersionDatabricks {
@JsonProperty("name")
private String name;
- /**
- * Open requests for this `model_versions`. Gap in sequence number is intentional and is done in
- * order to match field sequence numbers of `ModelVersion` proto message
- */
+ /** Open stage transition requests for the model version. */
@JsonProperty("open_requests")
private Collection openRequests;
- /** */
+ /**
+ * Permission level of the requesting user on the registered model that the version belongs to.
+ */
@JsonProperty("permission_level")
private PermissionLevel permissionLevel;
@@ -71,7 +73,9 @@ public class ModelVersionDatabricks {
@JsonProperty("source")
private String source;
- /** */
+ /**
+ * Registration status of the model version. The version can be used once the status is `READY`.
+ */
@JsonProperty("status")
private Status status;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchExperiments.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchExperiments.java
index e1cc5aaec..c3c066641 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchExperiments.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchExperiments.java
@@ -10,23 +10,34 @@
@Generated
public class SearchExperiments {
- /** String representing a SQL filter condition (e.g. "name ILIKE 'my-experiment%'") */
+ /**
+ * Filter condition on the experiment name and tags. The `name` attribute and `tags.` support
+ * the operators `=`, `!=`, `LIKE` and `ILIKE` (case-insensitive `LIKE`), string values are
+ * wrapped in single quotes, and several conditions can be combined with `AND`. No wildcard is
+ * added automatically, so include `%` in a `LIKE` pattern where you need one.
+ */
@JsonProperty("filter")
private String filter;
- /** Maximum number of experiments desired. Max threshold is 3000. */
+ /**
+ * Maximum number of experiments to return per page. Larger values are capped by the server, so
+ * use `page_token` to retrieve further pages.
+ */
@JsonProperty("max_results")
private Long maxResults;
/**
- * List of columns for ordering search results, which can include experiment name and last updated
- * timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Tiebreaks
- * are done by experiment id DESC.
+ * Columns to order the results by, each given as `name`, `basename` (the last segment of the
+ * name), `experiment_id`, `creation_time` or `last_update_time` with an optional `ASC` or `DESC`
+ * suffix, where `ASC` is the default. If omitted, results are ordered by last update time with
+ * the most recently updated experiment first. Tiebreaks are done by experiment id DESC.
*/
@JsonProperty("order_by")
private Collection orderBy;
- /** Token indicating the page of experiments to fetch */
+ /**
+ * Page token returned as `next_page_token` by a previous call. Omit it to fetch the first page.
+ */
@JsonProperty("page_token")
private String pageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsRequest.java
index 8a7ed38a8..d27471a0c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsRequest.java
@@ -12,8 +12,10 @@
@Generated
public class SearchModelVersionsRequest {
/**
- * String filter condition, like "name='my-model-name'". Must be a single boolean condition, with
- * string values wrapped in single quotes.
+ * Filter condition on `name`, `run_id`, `source` or `tags.`. The filter must constrain at
+ * least one of `name`, `run_id` or `source`. Conditions use `=`, `!=`, `LIKE` or `ILIKE`, and
+ * `run_id` also supports `IN`. String values are wrapped in single quotes, and several conditions
+ * can be combined with `AND`.
*/
@JsonIgnore
@QueryParam("filter")
@@ -25,9 +27,10 @@ public class SearchModelVersionsRequest {
private Long maxResults;
/**
- * List of columns to be ordered by including model name, version, stage with an optional "DESC"
- * or "ASC" annotation, where "ASC" is the default. Tiebreaks are done by latest stage transition
- * timestamp, followed by name ASC, followed by version DESC.
+ * Columns to order the results by, each given as `name`, `version`, `current_stage` or
+ * `last_updated_timestamp` with an optional `ASC` or `DESC` suffix, where `ASC` is the default.
+ * Tiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by
+ * version DESC.
*/
@JsonIgnore
@QueryParam("order_by")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsResponse.java
index e1b91c9bd..610923b14 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SearchModelVersionsResponse.java
@@ -10,7 +10,7 @@
@Generated
public class SearchModelVersionsResponse {
- /** Models that match the search criteria */
+ /** Model versions that match the search filter. */
@JsonProperty("model_versions")
private Collection modelVersions;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SetExperimentTag.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SetExperimentTag.java
index 4f4189737..7e181c1b7 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SetExperimentTag.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/SetExperimentTag.java
@@ -13,11 +13,15 @@ public class SetExperimentTag {
@JsonProperty("experiment_id")
private String experimentId;
- /** Name of the tag. Keys up to 250 bytes in size are supported. */
+ /**
+ * Key of the tag. Keys are at most 255 characters long. Setting a key that already exists
+ * replaces its value. System tags such as `mlflow.ownerId`, `mlflow.ownerEmail` and
+ * `mlflow.experimentType` cannot be set.
+ */
@JsonProperty("key")
private String key;
- /** String value of the tag being logged. Values up to 64KB in size are supported. */
+ /** Value of the tag. Values are at most 65535 characters long. */
@JsonProperty("value")
private String value;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateExperiment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateExperiment.java
index 81c894524..3f073e26d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateExperiment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateExperiment.java
@@ -13,7 +13,9 @@ public class UpdateExperiment {
@JsonProperty("experiment_id")
private String experimentId;
- /** If provided, the experiment's name is changed to the new name. The new name must be unique. */
+ /**
+ * New name for the experiment, as an absolute path in the workspace. The new name must be unique.
+ */
@JsonProperty("new_name")
private String newName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionRequest.java
index e0b689cfc..491e170b3 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionRequest.java
@@ -9,7 +9,7 @@
@Generated
public class UpdateModelVersionRequest {
- /** If provided, updates the description for this `registered_model`. */
+ /** New description for the model version. */
@JsonProperty("description")
private String description;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionResponse.java
index 524f42913..e9b65e3ea 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/ml/UpdateModelVersionResponse.java
@@ -9,7 +9,7 @@
@Generated
public class UpdateModelVersionResponse {
- /** Return new version number generated for this model in registry. */
+ /** The updated model version. */
@JsonProperty("model_version")
private ModelVersion modelVersion;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/IngestionSourceType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/IngestionSourceType.java
index 924680223..889645514 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/IngestionSourceType.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/pipelines/IngestionSourceType.java
@@ -12,6 +12,7 @@ public enum IngestionSourceType {
DYNAMICS365,
FOREIGN_CATALOG,
GA4_RAW_DATA,
+ GOOGLE_ADS,
GOOGLE_DRIVE,
JIRA,
MANAGED_POSTGRESQL,
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateDatabaseRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateDatabaseRequest.java
index 929f6065c..c80f354db 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateDatabaseRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateDatabaseRequest.java
@@ -19,8 +19,8 @@ public class CreateDatabaseRequest {
* The ID used to identify and manage the Database resource through the API. The Postgres database
* name is specified in `spec.postgres_database`.
*
- * This value should be 4-63 characters, and only use characters available in DNS names, 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 database_id is not specified in the request, it is generated automatically.
*/
@@ -34,7 +34,11 @@ public class CreateDatabaseRequest {
*/
@JsonIgnore private String parent;
- /** If true, update the database if it already exists instead of returning an error. */
+ /**
+ * If true, update the database if it already exists instead of returning an error. This requires
+ * `database_id` to be set. Without `database_id`, the request follows the normal create path and
+ * fails if the database name already exists.
+ */
@JsonIgnore
@QueryParam("replace_existing")
private Boolean replaceExisting;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSnapshotRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSnapshotRequest.java
index 1cb28410f..0ba94177a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSnapshotRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSnapshotRequest.java
@@ -14,13 +14,18 @@ public class CreateSnapshotRequest {
/** The project in which to create the snapshot. Format: projects/{project_id} */
@JsonIgnore private String parent;
- /** The snapshot to create. */
+ /**
+ * The snapshot to create. Only `spec` is read from this message; the system sets the other
+ * fields.
+ */
@JsonProperty("snapshot")
private Snapshot snapshot;
/**
* Client-chosen ID for the snapshot. It becomes the final segment of the snapshot resource name
- * and cannot be changed after creation.
+ * and cannot be changed after creation. The ID must be 3 to 63 characters long, start with a
+ * lowercase letter, end with a lowercase letter or digit, and contain only lowercase letters,
+ * digits, and hyphens.
*/
@JsonIgnore
@QueryParam("snapshot_id")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DatabaseDatabaseSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DatabaseDatabaseSpec.java
index 87b3c8948..71f0ebfcd 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DatabaseDatabaseSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/DatabaseDatabaseSpec.java
@@ -25,7 +25,8 @@ public class DatabaseDatabaseSpec {
* The name of the role that owns the database. Format:
* projects/{project_id}/branches/{branch_id}/roles/{role_id}
*
- *
To change the owner, pass valid existing Role name when updating the Database
+ *
The role must be in the same branch as the database. To change the owner, pass valid
+ * existing Role name when updating the Database
*
*
Required when creating the Database.
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java
index b6aee03ba..bf9a2dac7 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresAPI.java
@@ -127,7 +127,11 @@ public CreateRoleOperation createRole(CreateRoleRequest request) {
return new CreateRoleOperation(impl, operation);
}
- /** Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project. */
+ /**
+ * Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project.
+ * Returns a long-running operation. Poll it until done is true; its response holds the new
+ * snapshot.
+ */
public CreateSnapshotOperation createSnapshot(CreateSnapshotRequest request) {
Operation operation = impl.createSnapshot(request);
return new CreateSnapshotOperation(impl, operation);
@@ -191,7 +195,7 @@ public DeleteDatabaseOperation deleteDatabase(String name) {
return deleteDatabase(new DeleteDatabaseRequest().setName(name));
}
- /** Delete a Database. */
+ /** Deletes the specified Postgres database. */
public DeleteDatabaseOperation deleteDatabase(DeleteDatabaseRequest request) {
Operation operation = impl.deleteDatabase(request);
return new DeleteDatabaseOperation(impl, operation);
@@ -249,7 +253,10 @@ public DeleteSnapshotOperation deleteSnapshot(String name) {
return deleteSnapshot(new DeleteSnapshotRequest().setName(name));
}
- /** Deletes the specified snapshot. */
+ /**
+ * Deletes the specified snapshot. A deleted snapshot cannot be recovered. Returns a long-running
+ * operation. Poll it until done is true.
+ */
public DeleteSnapshotOperation deleteSnapshot(DeleteSnapshotRequest request) {
Operation operation = impl.deleteSnapshot(request);
return new DeleteSnapshotOperation(impl, operation);
@@ -337,7 +344,7 @@ public Database getDatabase(String name) {
return getDatabase(new GetDatabaseRequest().setName(name));
}
- /** Get a Database. */
+ /** Retrieves information about the specified Postgres database. */
public Database getDatabase(GetDatabaseRequest request) {
return impl.getDatabase(request);
}
@@ -509,7 +516,7 @@ public Iterable listDatabases(String parent) {
return listDatabases(new ListDatabasesRequest().setParent(parent));
}
- /** List Databases. */
+ /** Returns a list of Postgres databases in the branch. */
public Iterable listDatabases(ListDatabasesRequest request) {
return Paginator.newTokenPagination(
request,
@@ -669,7 +676,7 @@ public UpdateDataApiOperation updateDataApi(UpdateDataApiRequest request) {
return new UpdateDataApiOperation(impl, operation);
}
- /** Update a Database. */
+ /** Updates the specified Postgres database. Only the fields named in `update_mask` change. */
public UpdateDatabaseOperation updateDatabase(UpdateDatabaseRequest request) {
Operation operation = impl.updateDatabase(request);
return new UpdateDatabaseOperation(impl, operation);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java
index 98a4e3ac9..e474bfeba 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/PostgresService.java
@@ -80,7 +80,11 @@ Operation acknowledgeAssessmentWarnings(
/** Creates a new Postgres role in the branch. */
Operation createRole(CreateRoleRequest createRoleRequest);
- /** Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project. */
+ /**
+ * Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project.
+ * Returns a long-running operation. Poll it until done is true; its response holds the new
+ * snapshot.
+ */
Operation createSnapshot(CreateSnapshotRequest createSnapshotRequest);
/** Create a Synced Table. */
@@ -106,7 +110,7 @@ Operation acknowledgeAssessmentWarnings(
/** Disable Data API for a database. */
Operation deleteDataApi(DeleteDataApiRequest deleteDataApiRequest);
- /** Delete a Database. */
+ /** Deletes the specified Postgres database. */
Operation deleteDatabase(DeleteDatabaseRequest deleteDatabaseRequest);
/**
@@ -129,7 +133,10 @@ Operation acknowledgeAssessmentWarnings(
/** Deletes the specified Postgres role. */
Operation deleteRole(DeleteRoleRequest deleteRoleRequest);
- /** Deletes the specified snapshot. */
+ /**
+ * Deletes the specified snapshot. A deleted snapshot cannot be recovered. Returns a long-running
+ * operation. Poll it until done is true.
+ */
Operation deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest);
/** Delete a Synced Table. */
@@ -166,7 +173,7 @@ DatabaseCredential generateDatabaseCredential(
/** Get Data API configuration for a database. */
DataApi getDataApi(GetDataApiRequest getDataApiRequest);
- /** Get a Database. */
+ /** Retrieves information about the specified Postgres database. */
Database getDatabase(GetDatabaseRequest getDatabaseRequest);
/**
@@ -220,7 +227,7 @@ DatabaseCredential generateDatabaseCredential(
*/
ListCdfStatusesResponse listCdfStatuses(ListCdfStatusesRequest listCdfStatusesRequest);
- /** List Databases. */
+ /** Returns a list of Postgres databases in the branch. */
ListDatabasesResponse listDatabases(ListDatabasesRequest listDatabasesRequest);
/**
@@ -277,7 +284,7 @@ RevealRolePasswordResponse revealRolePassword(
/** Update Data API configuration for a database. */
Operation updateDataApi(UpdateDataApiRequest updateDataApiRequest);
- /** Update a Database. */
+ /** Updates the specified Postgres database. Only the fields named in `update_mask` change. */
Operation updateDatabase(UpdateDatabaseRequest updateDatabaseRequest);
/**
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Snapshot.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Snapshot.java
index b5eda006e..0ca647ed1 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Snapshot.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/Snapshot.java
@@ -10,7 +10,9 @@
/**
* An immutable, point-in-time copy of a branch's data within a project. It remains available after
- * the source branch is deleted.
+ * the source branch is deleted. To restore a snapshot, create a new branch with
+ * `spec.source_snapshot` set to the snapshot's resource name. For an overview, see
+ * https://docs.databricks.com/aws/en/oltp/projects/snapshots.
*/
@Generated
public class Snapshot {
@@ -26,7 +28,10 @@ public class Snapshot {
@JsonProperty("snapshot_id")
private String snapshotId;
- /** Client-provided configuration of the snapshot. */
+ /**
+ * Client-provided configuration of the snapshot. When you create a snapshot, set exactly one of
+ * `expire_time`, `ttl`, or `no_expiry`.
+ */
@JsonProperty("spec")
private SnapshotSpec spec;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SnapshotSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SnapshotSpec.java
index 5df886006..a8dd17e37 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SnapshotSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SnapshotSpec.java
@@ -13,30 +13,45 @@
@Generated
public class SnapshotSpec {
/**
- * Absolute time at which the snapshot is deleted. Mutually exclusive with `ttl` and `no_expiry`.
+ * Absolute time at which the snapshot is deleted. It must not be in the past. Mutually exclusive
+ * with `ttl` and `no_expiry`.
*/
@JsonProperty("expire_time")
private Timestamp expireTime;
- /** If true, the snapshot never expires. Mutually exclusive with `ttl` and `expire_time`. */
+ /**
+ * If true, the snapshot never expires. The value `false` is rejected; set `expire_time` or `ttl`
+ * instead. Mutually exclusive with `ttl` and `expire_time`.
+ */
@JsonProperty("no_expiry")
private Boolean noExpiry;
- /** The source branch to snapshot. Format: projects/{project_id}/branches/{branch_id} */
+ /**
+ * The source branch to snapshot. The branch must belong to the same project as the snapshot.
+ * Format: projects/{project_id}/branches/{branch_id}
+ */
@JsonProperty("source_branch")
private String sourceBranch;
- /** LSN to snapshot from, e.g. `16/B374D848`. Mutually exclusive with `source_branch_time`. */
+ /**
+ * Postgres log sequence number (LSN) to snapshot from. It must fall within the project's history
+ * retention window. If neither this field nor `source_branch_time` is set, the snapshot captures
+ * the current head of the source branch. Mutually exclusive with `source_branch_time`.
+ */
@JsonProperty("source_branch_lsn")
private String sourceBranchLsn;
- /** Timestamp to snapshot from. Mutually exclusive with `source_branch_lsn`. */
+ /**
+ * Timestamp to snapshot from. It must fall within the project's history retention window.
+ * Mutually exclusive with `source_branch_lsn`.
+ */
@JsonProperty("source_branch_time")
private Timestamp sourceBranchTime;
/**
- * Time-to-live. The snapshot expires this long after it is created. Mutually exclusive with
- * `expire_time` and `no_expiry`. Reads report the resolved absolute `expire_time` instead.
+ * Time-to-live, as a positive duration in seconds with an `s` suffix. The snapshot expires this
+ * long after it is created. Mutually exclusive with `expire_time` and `no_expiry`. Reads report
+ * the resolved absolute `expire_time` instead.
*/
@JsonProperty("ttl")
private Duration ttl;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateDatabaseRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateDatabaseRequest.java
index c1698c883..c867b7ef0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateDatabaseRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/UpdateDatabaseRequest.java
@@ -27,7 +27,10 @@ public class UpdateDatabaseRequest {
*/
@JsonIgnore private String name;
- /** The list of fields to update. */
+ /**
+ * The list of fields to update. The updatable fields are `spec.role` and
+ * `spec.postgres_database`.
+ */
@JsonIgnore
@QueryParam("update_mask")
private FieldMask updateMask;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsRequest.java
index 54410421c..bf08669b8 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsRequest.java
@@ -26,6 +26,11 @@ public class ListProviderShareAssetsRequest {
/** The name of the share. */
@JsonIgnore private String shareName;
+ /** Maximum number of skills to return. */
+ @JsonIgnore
+ @QueryParam("skill_max_results")
+ private Long skillMaxResults;
+
/** Maximum number of tables to return. */
@JsonIgnore
@QueryParam("table_max_results")
@@ -72,6 +77,15 @@ public String getShareName() {
return shareName;
}
+ public ListProviderShareAssetsRequest setSkillMaxResults(Long skillMaxResults) {
+ this.skillMaxResults = skillMaxResults;
+ return this;
+ }
+
+ public Long getSkillMaxResults() {
+ return skillMaxResults;
+ }
+
public ListProviderShareAssetsRequest setTableMaxResults(Long tableMaxResults) {
this.tableMaxResults = tableMaxResults;
return this;
@@ -99,6 +113,7 @@ public boolean equals(Object o) {
&& Objects.equals(notebookMaxResults, that.notebookMaxResults)
&& Objects.equals(providerName, that.providerName)
&& Objects.equals(shareName, that.shareName)
+ && Objects.equals(skillMaxResults, that.skillMaxResults)
&& Objects.equals(tableMaxResults, that.tableMaxResults)
&& Objects.equals(volumeMaxResults, that.volumeMaxResults);
}
@@ -110,6 +125,7 @@ public int hashCode() {
notebookMaxResults,
providerName,
shareName,
+ skillMaxResults,
tableMaxResults,
volumeMaxResults);
}
@@ -121,6 +137,7 @@ public String toString() {
.add("notebookMaxResults", notebookMaxResults)
.add("providerName", providerName)
.add("shareName", shareName)
+ .add("skillMaxResults", skillMaxResults)
.add("tableMaxResults", tableMaxResults)
.add("volumeMaxResults", volumeMaxResults)
.toString();
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsResponse.java
index 2c13866b5..c11918310 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/ListProviderShareAssetsResponse.java
@@ -23,6 +23,10 @@ public class ListProviderShareAssetsResponse {
@JsonProperty("share")
private Share share;
+ /** The list of skills in the share. */
+ @JsonProperty("skills")
+ private Collection skills;
+
/** The list of tables in the share. */
@JsonProperty("tables")
private Collection tables;
@@ -58,6 +62,15 @@ public Share getShare() {
return share;
}
+ public ListProviderShareAssetsResponse setSkills(Collection skills) {
+ this.skills = skills;
+ return this;
+ }
+
+ public Collection getSkills() {
+ return skills;
+ }
+
public ListProviderShareAssetsResponse setTables(Collection tables) {
this.tables = tables;
return this;
@@ -84,13 +97,14 @@ public boolean equals(Object o) {
return Objects.equals(functions, that.functions)
&& Objects.equals(notebooks, that.notebooks)
&& Objects.equals(share, that.share)
+ && Objects.equals(skills, that.skills)
&& Objects.equals(tables, that.tables)
&& Objects.equals(volumes, that.volumes);
}
@Override
public int hashCode() {
- return Objects.hash(functions, notebooks, share, tables, volumes);
+ return Objects.hash(functions, notebooks, share, skills, tables, volumes);
}
@Override
@@ -99,6 +113,7 @@ public String toString() {
.add("functions", functions)
.add("notebooks", notebooks)
.add("share", share)
+ .add("skills", skills)
.add("tables", tables)
.add("volumes", volumes)
.toString();
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/SharedDataObjectDataObjectType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/SharedDataObjectDataObjectType.java
index 860d6bf77..43c94724c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/SharedDataObjectDataObjectType.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/SharedDataObjectDataObjectType.java
@@ -13,6 +13,7 @@ public enum SharedDataObjectDataObjectType {
MODEL,
NOTEBOOK_FILE,
SCHEMA,
+ SKILL,
STREAMING_TABLE,
TABLE,
VIEW,
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/Skill.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/Skill.java
new file mode 100644
index 000000000..5d2539206
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sharing/Skill.java
@@ -0,0 +1,153 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.sharing;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+/** An agent skill shared through a Delta Sharing share, as served to a recipient. */
+@Generated
+public class Skill {
+ /** The name from the skill bundle frontmatter, which may differ from the resource name. */
+ @JsonProperty("bundle_name")
+ private String bundleName;
+
+ /** The comment of the skill. */
+ @JsonProperty("comment")
+ private String comment;
+
+ /** The bundle description parsed from the skill bundle's SKILL.md frontmatter. */
+ @JsonProperty("description")
+ private String description;
+
+ /**
+ * The shared-object ID that recipients match replicas on. For a skill shared through its schema,
+ * which has no shared-object row, this is derived from the shared schema and the skill.
+ */
+ @JsonProperty("id")
+ private String id;
+
+ /** The name of the skill. */
+ @JsonProperty("name")
+ private String name;
+
+ /** The name of the schema that the skill belongs to. */
+ @JsonProperty("schema")
+ private String schema;
+
+ /** The name of the share that the skill belongs to. */
+ @JsonProperty("share")
+ private String share;
+
+ /** The id of the share that the skill belongs to. */
+ @JsonProperty("share_id")
+ private String shareId;
+
+ public Skill setBundleName(String bundleName) {
+ this.bundleName = bundleName;
+ return this;
+ }
+
+ public String getBundleName() {
+ return bundleName;
+ }
+
+ public Skill setComment(String comment) {
+ this.comment = comment;
+ return this;
+ }
+
+ public String getComment() {
+ return comment;
+ }
+
+ public Skill setDescription(String description) {
+ this.description = description;
+ return this;
+ }
+
+ public String getDescription() {
+ return description;
+ }
+
+ public Skill setId(String id) {
+ this.id = id;
+ return this;
+ }
+
+ public String getId() {
+ return id;
+ }
+
+ public Skill setName(String name) {
+ this.name = name;
+ return this;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public Skill setSchema(String schema) {
+ this.schema = schema;
+ return this;
+ }
+
+ public String getSchema() {
+ return schema;
+ }
+
+ public Skill setShare(String share) {
+ this.share = share;
+ return this;
+ }
+
+ public String getShare() {
+ return share;
+ }
+
+ public Skill setShareId(String shareId) {
+ this.shareId = shareId;
+ return this;
+ }
+
+ public String getShareId() {
+ return shareId;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ Skill that = (Skill) o;
+ return Objects.equals(bundleName, that.bundleName)
+ && Objects.equals(comment, that.comment)
+ && Objects.equals(description, that.description)
+ && Objects.equals(id, that.id)
+ && Objects.equals(name, that.name)
+ && Objects.equals(schema, that.schema)
+ && Objects.equals(share, that.share)
+ && Objects.equals(shareId, that.shareId);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(bundleName, comment, description, id, name, schema, share, shareId);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(Skill.class)
+ .add("bundleName", bundleName)
+ .add("comment", comment)
+ .add("description", description)
+ .add("id", id)
+ .add("name", name)
+ .add("schema", schema)
+ .add("share", share)
+ .add("shareId", shareId)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/GetSoftwareArtifactVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/GetSoftwareArtifactVersionRequest.java
index 5fda12ada..4d9dbac47 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/GetSoftwareArtifactVersionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/GetSoftwareArtifactVersionRequest.java
@@ -11,7 +11,8 @@
public class GetSoftwareArtifactVersionRequest {
/**
* Resource name of the version, of the form
- * `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.
+ * `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where `{version}` is the
+ * version's content digest.
*/
@JsonIgnore private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/ResolveSoftwareArtifactVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/ResolveSoftwareArtifactVersionRequest.java
index d14e6add5..40795f8e2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/ResolveSoftwareArtifactVersionRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/ResolveSoftwareArtifactVersionRequest.java
@@ -11,11 +11,18 @@
/** Request to resolve a software artifact version from its tag alias. */
@Generated
public class ResolveSoftwareArtifactVersionRequest {
- /** Image tag alias selecting the version. */
+ /**
+ * Image tag alias selecting the version. The alias must be a valid OCI image tag of at most 128
+ * characters, made of letters, digits, underscores, periods, and hyphens, and must not start with
+ * a period or hyphen.
+ */
@JsonProperty("alias")
private String alias;
- /** Resource name of the software artifact containing the alias. */
+ /**
+ * Resource name of the software artifact containing the alias, of the form
+ * `software-artifacts/{catalog}.{schema}.{artifact}`.
+ */
@JsonIgnore private String parent;
public ResolveSoftwareArtifactVersionRequest setAlias(String alias) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifact.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifact.java
index c80418fc5..7eab21df3 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifact.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifact.java
@@ -8,10 +8,16 @@
import com.google.protobuf.Timestamp;
import java.util.Objects;
-/** A software artifact in a Unity Catalog schema. */
+/**
+ * A software artifact is a named container image stored in a Unity Catalog schema and governed by
+ * Unity Catalog privileges. Images are pushed through Databricks Artifact Registry; each pushed
+ * image digest becomes an immutable version of the artifact, exposed as a SoftwareArtifactVersion.
+ * See https://docs.databricks.com/aws/en/artifact-registry/ for concepts, naming rules, and the
+ * privileges each operation requires.
+ */
@Generated
public class SoftwareArtifact {
- /** Time at which this software artifact was created. */
+ /** Time at which the artifact was created, formatted as an RFC 3339 timestamp in JSON. */
@JsonProperty("create_time")
private Timestamp createTime;
@@ -25,11 +31,14 @@ public class SoftwareArtifact {
@JsonProperty("name")
private String name;
- /** Principal name (a user, service principal, or group) that owns this artifact. */
+ /**
+ * Principal that owns the artifact, given as a user's email address, a service principal's
+ * application ID, or a group name.
+ */
@JsonProperty("owner")
private String owner;
- /** Time at which this software artifact was last updated. */
+ /** Time at which the artifact was last updated, formatted as an RFC 3339 timestamp in JSON. */
@JsonProperty("update_time")
private Timestamp updateTime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactVersion.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactVersion.java
index d1ddc2922..ed5d01726 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactVersion.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/softwareartifacts/SoftwareArtifactVersion.java
@@ -12,7 +12,10 @@
/** An immutable version of a software artifact, identified by its content digest. */
@Generated
public class SoftwareArtifactVersion {
- /** Time at which this software artifact version was created. */
+ /**
+ * Time at which this software artifact version was created, formatted as an RFC 3339 timestamp in
+ * JSON.
+ */
@JsonProperty("create_time")
private Timestamp createTime;
@@ -20,7 +23,7 @@ public class SoftwareArtifactVersion {
@JsonProperty("created_by")
private String createdBy;
- /** Content digest of the version, for example `sha256:...`. */
+ /** Content digest of the version's image manifest, of the form `{algorithm}:{hex}`. */
@JsonProperty("digest")
private String digest;
@@ -30,7 +33,8 @@ public class SoftwareArtifactVersion {
/**
* Resource name of the version, of the form
- * `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.
+ * `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`, where `{version}` is the
+ * version's content digest.
*/
@JsonProperty("name")
private String name;
@@ -42,7 +46,10 @@ public class SoftwareArtifactVersion {
@JsonProperty("tags")
private Collection tags;
- /** Time at which this software artifact version was last updated. */
+ /**
+ * Time at which this software artifact version was last updated, formatted as an RFC 3339
+ * timestamp in JSON.
+ */
@JsonProperty("update_time")
private Timestamp updateTime;
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 3ad479688..34a559484 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
@@ -28,7 +28,10 @@ public SoftwareArtifact getSoftwareArtifact(String name) {
return getSoftwareArtifact(new GetSoftwareArtifactRequest().setName(name));
}
- /** Gets a software artifact. */
+ /**
+ * Gets a software artifact by its resource name. Returns `NOT_FOUND` if the artifact does not
+ * exist.
+ */
public SoftwareArtifact getSoftwareArtifact(GetSoftwareArtifactRequest request) {
return impl.getSoftwareArtifact(request);
}
@@ -37,7 +40,10 @@ public SoftwareArtifactVersion getSoftwareArtifactVersion(String name) {
return getSoftwareArtifactVersion(new GetSoftwareArtifactVersionRequest().setName(name));
}
- /** Gets a software artifact version. */
+ /**
+ * Gets a software artifact version by its resource name. Returns `NOT_FOUND` if the version does
+ * not exist.
+ */
public SoftwareArtifactVersion getSoftwareArtifactVersion(
GetSoftwareArtifactVersionRequest request) {
return impl.getSoftwareArtifactVersion(request);
@@ -83,7 +89,10 @@ public Iterable listSoftwareArtifacts(ListSoftwareArtifactsReq
});
}
- /** Resolves a software artifact version from its tag alias. */
+ /**
+ * Resolves a software artifact version from its tag alias. Returns `NOT_FOUND` if the artifact or
+ * the alias does not exist.
+ */
public ResolveSoftwareArtifactVersionResponse resolveSoftwareArtifactVersion(
ResolveSoftwareArtifactVersionRequest request) {
return impl.resolveSoftwareArtifactVersion(request);
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 e386956c4..f1c8b652c 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,10 +12,16 @@
*/
@Generated
public interface SoftwareArtifactsService {
- /** Gets a software artifact. */
+ /**
+ * Gets a software artifact by its resource name. Returns `NOT_FOUND` if the artifact does not
+ * exist.
+ */
SoftwareArtifact getSoftwareArtifact(GetSoftwareArtifactRequest getSoftwareArtifactRequest);
- /** Gets a software artifact version. */
+ /**
+ * Gets a software artifact version by its resource name. Returns `NOT_FOUND` if the version does
+ * not exist.
+ */
SoftwareArtifactVersion getSoftwareArtifactVersion(
GetSoftwareArtifactVersionRequest getSoftwareArtifactVersionRequest);
@@ -27,7 +33,10 @@ ListSoftwareArtifactVersionsResponse listSoftwareArtifactVersions(
ListSoftwareArtifactsResponse listSoftwareArtifacts(
ListSoftwareArtifactsRequest listSoftwareArtifactsRequest);
- /** Resolves a software artifact version from its tag alias. */
+ /**
+ * Resolves a software artifact version from its tag alias. Returns `NOT_FOUND` if the artifact or
+ * the alias does not exist.
+ */
ResolveSoftwareArtifactVersionResponse resolveSoftwareArtifactVersion(
ResolveSoftwareArtifactVersionRequest resolveSoftwareArtifactVersionRequest);
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 384bdccb1..3c1495787 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
@@ -14,7 +14,8 @@ public class CreateWarehouseRequest {
* The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries)
* before it is automatically stopped.
*
- * Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.
+ *
Supported values: - Must be == 0 or >= 1 min for serverless warehouses. - Must be == 0 or >=
+ * 10 mins for classic and pro warehouses. - 0 indicates no autostop.
*
*
Defaults to 120 mins
*/
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 857f245f1..c49994183 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
@@ -19,7 +19,8 @@ public class EditWarehouseRequest {
* The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries)
* before it is automatically stopped.
*
- *
Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.
+ *
Supported values: - Must be == 0 or >= 1 min for serverless warehouses. - Must be == 0 or >=
+ * 10 mins for classic and pro warehouses. - 0 indicates no autostop.
*
*
Defaults to 120 mins
*/
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 a9f62b4f6..f6169d975 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
@@ -13,7 +13,8 @@ public class EndpointInfo {
* The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries)
* before it is automatically stopped.
*
- *
Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.
+ *
Supported values: - Must be == 0 or >= 1 min for serverless warehouses. - Must be == 0 or >=
+ * 10 mins for classic and pro warehouses. - 0 indicates no autostop.
*
*
Defaults to 120 mins
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalQuerySource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalQuerySource.java
index 762b2f47a..4d0b65524 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalQuerySource.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ExternalQuerySource.java
@@ -21,7 +21,10 @@ public class ExternalQuerySource {
@JsonProperty("genie_space_id")
private String genieSpaceId;
- /** */
+ /**
+ * Identifiers of the job, job run, and task run that executed this statement, when it ran as part
+ * of a job.
+ */
@JsonProperty("job_info")
private ExternalQuerySourceJobInfo jobInfo;
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 861bbfb93..70cd14fb9 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
@@ -13,7 +13,8 @@ public class GetWarehouseResponse {
* The amount of time in minutes that a SQL warehouse must be idle (i.e., no RUNNING queries)
* before it is automatically stopped.
*
- *
Supported values: - Must be == 0 or >= 10 mins - 0 indicates no autostop.
+ *
Supported values: - Must be == 0 or >= 1 min for serverless warehouses. - Must be == 0 or >=
+ * 10 mins for classic and pro warehouses. - 0 indicates no autostop.
*
*
Defaults to 120 mins
*/
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryHistoryRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryHistoryRequest.java
index 8c0e7286d..857dfb25a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryHistoryRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/ListQueryHistoryRequest.java
@@ -12,8 +12,8 @@
public class ListQueryHistoryRequest {
/**
* An optional filter object to limit query history results. Accepts parameters such as user IDs,
- * endpoint IDs, and statuses to narrow the returned data. In a URL, the parameters of this filter
- * are specified with dot notation. For example: `filter_by.statement_ids`.
+ * warehouse IDs, and statuses to narrow the returned data. In a URL, the parameters of this
+ * filter are specified with dot notation. For example: `filter_by.statement_ids`.
*/
@JsonIgnore
@QueryParam("filter_by")
@@ -28,7 +28,7 @@ public class ListQueryHistoryRequest {
private Boolean includeMetrics;
/**
- * Limit the number of results returned in one page. Must be less than 1000 and the default is
+ * Limit the number of results returned in one page. Must be no more than 1000; the default is
* 100.
*/
@JsonIgnore
@@ -36,8 +36,8 @@ public class ListQueryHistoryRequest {
private Long maxResults;
/**
- * A token that can be used to get the next page of results. The token can contains characters
- * that need to be encoded before using it in a URL. For example, the character '+' needs to be
+ * A token that can be used to get the next page of results. The token can contain characters that
+ * need to be encoded before using it in a URL. For example, the character '+' needs to be
* replaced by %2B. This field is optional.
*/
@JsonIgnore
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryInfo.java
index 3b693ea9d..09d55981b 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryInfo.java
@@ -10,7 +10,10 @@
@Generated
public class QueryInfo {
- /** The ID of the cached query if this result retrieved from cache */
+ /**
+ * The ID of the query whose cached result was returned, if this result was retrieved from the
+ * cache.
+ */
@JsonProperty("cache_query_id")
private String cacheQueryId;
@@ -27,9 +30,9 @@ public class QueryInfo {
private String clientApplication;
/**
- * Total time of the statement execution. This value does not include the time taken to retrieve
- * the results, which can result in a discrepancy between this value and the start-to-finish
- * wall-clock time.
+ * Total time of the statement execution, in milliseconds. This value does not include the time
+ * taken to retrieve the results, which can result in a discrepancy between this value and the
+ * start-to-finish wall-clock time.
*/
@JsonProperty("duration")
private Long duration;
@@ -50,11 +53,13 @@ public class QueryInfo {
@JsonProperty("executed_as_user_name")
private String executedAsUserName;
- /** The time execution of the query ended. */
+ /** The time execution of the query ended, in milliseconds since the Unix epoch. */
@JsonProperty("execution_end_time_ms")
private Long executionEndTimeMs;
- /** Whether more updates for the query are expected. */
+ /**
+ * Whether the query has reached a final state, so no further updates to this record are expected.
+ */
@JsonProperty("is_final")
private Boolean isFinal;
@@ -62,7 +67,7 @@ public class QueryInfo {
@JsonProperty("lookup_key")
private String lookupKey;
- /** Metrics about query execution. */
+ /** Metrics about query execution. Only returned when `include_metrics` is true in the request. */
@JsonProperty("metrics")
private QueryMetrics metrics;
@@ -70,11 +75,14 @@ public class QueryInfo {
@JsonProperty("plans_state")
private PlansState plansState;
- /** The time the query ended. */
+ /** The time the query ended, in milliseconds since the Unix epoch. */
@JsonProperty("query_end_time_ms")
private Long queryEndTimeMs;
- /** The query ID. */
+ /**
+ * The UUID that uniquely identifies the query execution. It matches the statement ID shown in the
+ * Query History UI and the values accepted by the `statement_ids` filter.
+ */
@JsonProperty("query_id")
private String queryId;
@@ -86,11 +94,15 @@ public class QueryInfo {
@JsonProperty("query_source")
private ExternalQuerySource querySource;
- /** The time the query started. */
+ /** The time the query started, in milliseconds since the Unix epoch. */
@JsonProperty("query_start_time_ms")
private Long queryStartTimeMs;
- /** A query execution can be optionally annotated with query tags */
+ /**
+ * Key-value tags attached to the query execution, for example with the `SET QUERY_TAGS`
+ * statement, for grouping and filtering. See
+ * https://docs.databricks.com/aws/en/sql/user/queries/query-tags.
+ */
@JsonProperty("query_tags")
private Collection queryTags;
@@ -118,7 +130,7 @@ public class QueryInfo {
private QueryStatementType statementType;
/**
- * Query status with one the following values:
+ * Query status with one of the following values:
*
* - `QUEUED`: Query has been received and queued. - `RUNNING`: Query has started. -
* `CANCELED`: Query has been cancelled by the user. - `FAILED`: Query has failed. - `FINISHED`:
@@ -135,7 +147,7 @@ public class QueryInfo {
@JsonProperty("user_name")
private String userName;
- /** Warehouse ID. */
+ /** ID of the warehouse that ran the query. */
@JsonProperty("warehouse_id")
private String warehouseId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryMetrics.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryMetrics.java
index 2030d9210..e10358252 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryMetrics.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryMetrics.java
@@ -26,8 +26,9 @@ public class QueryMetrics {
private Long networkSentBytes;
/**
- * Timestamp of when the query was enqueued waiting while the warehouse was at max load. This
- * field is optional and will not appear if the query skipped the overloading queue.
+ * Timestamp of when the query was enqueued waiting while the warehouse was at max load, in
+ * milliseconds since the Unix epoch. This field is optional and will not appear if the query
+ * skipped the overloading queue.
*/
@JsonProperty("overloading_queue_start_timestamp")
private Long overloadingQueueStartTimestamp;
@@ -54,8 +55,8 @@ public class QueryMetrics {
/**
* Timestamp of when the query was enqueued waiting for a cluster to be provisioned for the
- * warehouse. This field is optional and will not appear if the query skipped the provisioning
- * queue.
+ * warehouse, in milliseconds since the Unix epoch. This field is optional and will not appear if
+ * the query skipped the provisioning queue.
*/
@JsonProperty("provisioning_queue_start_timestamp")
private Long provisioningQueueStartTimestamp;
@@ -68,7 +69,10 @@ public class QueryMetrics {
@JsonProperty("pruned_files_count")
private Long prunedFilesCount;
- /** Timestamp of when the underlying compute started compilation of the query. */
+ /**
+ * Timestamp of when the underlying compute started compilation of the query, in milliseconds
+ * since the Unix epoch.
+ */
@JsonProperty("query_compilation_start_timestamp")
private Long queryCompilationStartTimestamp;
@@ -119,10 +123,7 @@ public class QueryMetrics {
@JsonProperty("rows_read_count")
private Long rowsReadCount;
- /**
- * number of remaining tasks to complete, calculated by autoscaler StatementAnalysis.scala
- * deprecated: use remaining_task_count instead
- */
+ /** Deprecated: use `remaining_task_count` instead. Number of remaining tasks to complete. */
@JsonProperty("runnable_tasks")
private Long runnableTasks;
@@ -146,14 +147,13 @@ public class QueryMetrics {
private Long totalTimeMs;
/**
- * remaining work to be done across all stages in the query, calculated by autoscaler
- * StatementAnalysis.scala, in milliseconds deprecated: using
- * projected_remaining_task_total_time_ms instead
+ * Deprecated: use `projected_remaining_task_total_time_ms` instead. Remaining work to be done
+ * across all stages in the query, in milliseconds.
*/
@JsonProperty("work_to_be_done")
private Long workToBeDone;
- /** Size pf persistent data written to cloud object storage in your cloud tenant, in bytes. */
+ /** Size of persistent data written to cloud object storage in your cloud tenant, in bytes. */
@JsonProperty("write_remote_bytes")
private Long writeRemoteBytes;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryTag.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryTag.java
index bf5c34bcd..21c6bb823 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryTag.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/QueryTag.java
@@ -14,11 +14,11 @@
*/
@Generated
public class QueryTag {
- /** */
+ /** The key of the tag. */
@JsonProperty("key")
private String key;
- /** */
+ /** The value of the tag. Key-only tags have no value. */
@JsonProperty("value")
private String value;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TaskTimeOverRange.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TaskTimeOverRange.java
index c8b21f225..3de95a07e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TaskTimeOverRange.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TaskTimeOverRange.java
@@ -10,7 +10,10 @@
@Generated
public class TaskTimeOverRange {
- /** */
+ /**
+ * Each entry covers one consecutive time bucket of length `interval`, starting at
+ * `query_start_time_ms`.
+ */
@JsonProperty("entries")
private Collection entries;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TimeRange.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TimeRange.java
index 93cdd858c..e5008b4f9 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TimeRange.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/sql/TimeRange.java
@@ -10,12 +10,12 @@
@Generated
public class TimeRange {
- /** The end time in milliseconds. */
+ /** End of the range, in milliseconds since the Unix epoch. */
@JsonProperty("end_time_ms")
@QueryParam("end_time_ms")
private Long endTimeMs;
- /** The start time in milliseconds. */
+ /** Start of the range, in milliseconds since the Unix epoch. */
@JsonProperty("start_time_ms")
@QueryParam("start_time_ms")
private Long startTimeMs;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/QueryTag.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/QueryTag.java
index b7a0e7a3c..c8aa6df80 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/QueryTag.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/statementexecutionv2/QueryTag.java
@@ -14,11 +14,11 @@
*/
@Generated
public class QueryTag {
- /** */
+ /** The key of the tag. */
@JsonProperty("key")
private String key;
- /** */
+ /** The value of the tag. Key-only tags have no value. */
@JsonProperty("value")
private String value;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagAssignment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagAssignment.java
index 2cddc0d88..3139e3913 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagAssignment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/TagAssignment.java
@@ -7,6 +7,13 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * A tag assignment attaches a tag, which is a key with an optional value, to a workspace object
+ * such as a dashboard, notebook, Genie space or app. An object can have at most one assignment for
+ * each tag key. If the key belongs to a governed tag, the caller needs the ASSIGN permission on
+ * that governed tag, and the value must be one of its allowed values. See
+ * https://docs.databricks.com/aws/en/admin/governed-tags/.
+ */
@Generated
public class TagAssignment {
/**
@@ -27,7 +34,7 @@ public class TagAssignment {
@JsonProperty("tag_key")
private String tagKey;
- /** The value of the tag */
+ /** The value of the tag. If the value is omitted, the tag is assigned with its key only. */
@JsonProperty("tag_value")
private String tagValue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagAssignmentRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagAssignmentRequest.java
index 21f6e0c33..17b6ec170 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagAssignmentRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/tags/UpdateTagAssignmentRequest.java
@@ -31,15 +31,8 @@ public class UpdateTagAssignmentRequest {
@JsonIgnore private String tagKey;
/**
- * 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 fields to update. Only `tag_value` can be updated, because the
+ * entity type, entity ID and tag key identify the tag assignment.
*/
@JsonIgnore
@QueryParam("update_mask")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/FailedStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/FailedStatus.java
new file mode 100644
index 000000000..ccc2daec3
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/FailedStatus.java
@@ -0,0 +1,96 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.vectorsearch;
+
+import com.databricks.sdk.support.Generated;
+import com.databricks.sdk.support.ToStringer;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.google.protobuf.Timestamp;
+import java.util.Objects;
+
+/** Failure details for an index or its latest ingestion update. */
+@Generated
+public class FailedStatus {
+ /** Error code associated with the error message, when available. */
+ @JsonProperty("error_code")
+ private String errorCode;
+
+ /** Error message, when available. */
+ @JsonProperty("error_message")
+ private String errorMessage;
+
+ /**
+ * [Standard endpoint] timestamp when the last processed commit was committed to the source table.
+ * [Storage Optimized endpoint] timestamp when the last processed commit was processed by the
+ * pipeline.
+ */
+ @JsonProperty("last_processed_commit_timestamp")
+ private Timestamp lastProcessedCommitTimestamp;
+
+ /** Last source Delta table version fully processed while the index is still queryable. */
+ @JsonProperty("last_processed_commit_version")
+ private Long lastProcessedCommitVersion;
+
+ public FailedStatus setErrorCode(String errorCode) {
+ this.errorCode = errorCode;
+ return this;
+ }
+
+ public String getErrorCode() {
+ return errorCode;
+ }
+
+ public FailedStatus setErrorMessage(String errorMessage) {
+ this.errorMessage = errorMessage;
+ return this;
+ }
+
+ public String getErrorMessage() {
+ return errorMessage;
+ }
+
+ public FailedStatus setLastProcessedCommitTimestamp(Timestamp lastProcessedCommitTimestamp) {
+ this.lastProcessedCommitTimestamp = lastProcessedCommitTimestamp;
+ return this;
+ }
+
+ public Timestamp getLastProcessedCommitTimestamp() {
+ return lastProcessedCommitTimestamp;
+ }
+
+ public FailedStatus setLastProcessedCommitVersion(Long lastProcessedCommitVersion) {
+ this.lastProcessedCommitVersion = lastProcessedCommitVersion;
+ return this;
+ }
+
+ public Long getLastProcessedCommitVersion() {
+ return lastProcessedCommitVersion;
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (this == o) return true;
+ if (o == null || getClass() != o.getClass()) return false;
+ FailedStatus that = (FailedStatus) o;
+ return Objects.equals(errorCode, that.errorCode)
+ && Objects.equals(errorMessage, that.errorMessage)
+ && Objects.equals(lastProcessedCommitTimestamp, that.lastProcessedCommitTimestamp)
+ && Objects.equals(lastProcessedCommitVersion, that.lastProcessedCommitVersion);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash(
+ errorCode, errorMessage, lastProcessedCommitTimestamp, lastProcessedCommitVersion);
+ }
+
+ @Override
+ public String toString() {
+ return new ToStringer(FailedStatus.class)
+ .add("errorCode", errorCode)
+ .add("errorMessage", errorMessage)
+ .add("lastProcessedCommitTimestamp", lastProcessedCommitTimestamp)
+ .add("lastProcessedCommitVersion", lastProcessedCommitVersion)
+ .toString();
+ }
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/IndexStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/IndexStatus.java
new file mode 100644
index 000000000..d93e2c4e7
--- /dev/null
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/IndexStatus.java
@@ -0,0 +1,25 @@
+// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
+
+package com.databricks.sdk.service.vectorsearch;
+
+import com.databricks.sdk.support.Generated;
+
+/** Lifecycle and ingestion state of an index. */
+@Generated
+public enum IndexStatus {
+ DOWNLOADING,
+ OFFLINE,
+ OFFLINE_FAILED,
+ ONLINE,
+ ONLINE_CONTINUOUS_UPDATE,
+ ONLINE_DIRECT_ACCESS,
+ ONLINE_NO_PENDING_UPDATE,
+ ONLINE_PIPELINE_FAILED,
+ ONLINE_TRIGGERED_UPDATE,
+ ONLINE_UPDATING_PIPELINE_RESOURCES,
+ PROVISIONING,
+ PROVISIONING_ENDPOINT,
+ PROVISIONING_INDEX,
+ PROVISIONING_INITIAL_SNAPSHOT,
+ PROVISIONING_PIPELINE_RESOURCES,
+}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndexStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndexStatus.java
index 83868a47b..ba6a90fee 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndexStatus.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndexStatus.java
@@ -9,6 +9,14 @@
@Generated
public class VectorIndexStatus {
+ /** Lifecycle and ingestion state. An online index can still have a failed update. */
+ @JsonProperty("detailed_state")
+ private IndexStatus detailedState;
+
+ /** Failure details, when available, for OFFLINE_FAILED or ONLINE_PIPELINE_FAILED. */
+ @JsonProperty("failed_status")
+ private FailedStatus failedStatus;
+
/** Index API Url to be used to perform operations on the index */
@JsonProperty("index_url")
private String indexUrl;
@@ -21,10 +29,31 @@ public class VectorIndexStatus {
@JsonProperty("message")
private String message;
- /** Whether the index is ready for search */
+ /**
+ * Whether the index can serve queries. This does not mean the latest update succeeded or that all
+ * source-table changes have been indexed; check detailed_state for update failures.
+ */
@JsonProperty("ready")
private Boolean ready;
+ public VectorIndexStatus setDetailedState(IndexStatus detailedState) {
+ this.detailedState = detailedState;
+ return this;
+ }
+
+ public IndexStatus getDetailedState() {
+ return detailedState;
+ }
+
+ public VectorIndexStatus setFailedStatus(FailedStatus failedStatus) {
+ this.failedStatus = failedStatus;
+ return this;
+ }
+
+ public FailedStatus getFailedStatus() {
+ return failedStatus;
+ }
+
public VectorIndexStatus setIndexUrl(String indexUrl) {
this.indexUrl = indexUrl;
return this;
@@ -66,7 +95,9 @@ public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
VectorIndexStatus that = (VectorIndexStatus) o;
- return Objects.equals(indexUrl, that.indexUrl)
+ return Objects.equals(detailedState, that.detailedState)
+ && Objects.equals(failedStatus, that.failedStatus)
+ && Objects.equals(indexUrl, that.indexUrl)
&& Objects.equals(indexedRowCount, that.indexedRowCount)
&& Objects.equals(message, that.message)
&& Objects.equals(ready, that.ready);
@@ -74,12 +105,14 @@ public boolean equals(Object o) {
@Override
public int hashCode() {
- return Objects.hash(indexUrl, indexedRowCount, message, ready);
+ return Objects.hash(detailedState, failedStatus, indexUrl, indexedRowCount, message, ready);
}
@Override
public String toString() {
return new ToStringer(VectorIndexStatus.class)
+ .add("detailedState", detailedState)
+ .add("failedStatus", failedStatus)
.add("indexUrl", indexUrl)
.add("indexedRowCount", indexedRowCount)
.add("message", message)
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsRequest.java
index 8939b7e44..f87059faa 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsRequest.java
@@ -36,11 +36,18 @@ public class CreateCredentialsRequest {
@JsonProperty("git_username")
private String gitUsername;
- /** if the credential is the default for the given provider */
+ /**
+ * Set to true to make the new credential the default for its Git provider, replacing the current
+ * default. The first credential created for a provider becomes the default regardless of this
+ * value.
+ */
@JsonProperty("is_default_for_provider")
private Boolean isDefaultForProvider;
- /** the name of the git credential, used for identification and ease of lookup */
+ /**
+ * The name of the Git credential, used for identification and ease of lookup. It must not exceed
+ * 100 characters.
+ */
@JsonProperty("name")
private String name;
@@ -54,8 +61,8 @@ public class CreateCredentialsRequest {
private String personalAccessToken;
/**
- * The ID of the service principal whose credentials will be modified. Only service principal
- * managers can perform this action.
+ * The ID of the service principal for which the credential will be created. Only service
+ * principal managers can perform this action.
*/
@JsonProperty("principal_id")
private Long principalId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsResponse.java
index d29f062ec..de5fcb123 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CreateCredentialsResponse.java
@@ -35,11 +35,14 @@ public class CreateCredentialsResponse {
@JsonProperty("git_username")
private String gitUsername;
- /** if the credential is the default for the given provider */
+ /**
+ * Whether this credential is the default for its Git provider. The default credential is the
+ * fallback that is used when no specific credential is selected.
+ */
@JsonProperty("is_default_for_provider")
private Boolean isDefaultForProvider;
- /** the name of the git credential, used for identification and ease of lookup */
+ /** The name of the Git credential, used for identification and ease of lookup. */
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CredentialInfo.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CredentialInfo.java
index 5731abc23..3b569c3c5 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CredentialInfo.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/CredentialInfo.java
@@ -7,6 +7,11 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * A Git credential that Databricks uses to authenticate to a Git provider on behalf of a user or
+ * service principal. Each user has one default credential per Git provider, which is used when no
+ * specific credential is selected.
+ */
@Generated
public class CredentialInfo {
/** ID of the credential object in the workspace. */
@@ -40,11 +45,15 @@ public class CredentialInfo {
@JsonProperty("git_username")
private String gitUsername;
- /** if the credential is the default for the given provider */
+ /**
+ * Whether this credential is the default for its Git provider. The default credential is the
+ * fallback that is used when no specific credential is selected. See
+ * https://docs.databricks.com/aws/en/repos/repos-setup#how-default-credentials-work.
+ */
@JsonProperty("is_default_for_provider")
private Boolean isDefaultForProvider;
- /** the name of the git credential, used for identification and ease of lookup */
+ /** The name of the Git credential, used for identification and ease of lookup. */
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteCredentialsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteCredentialsRequest.java
index e063d5716..04b879901 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteCredentialsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/DeleteCredentialsRequest.java
@@ -14,7 +14,7 @@ public class DeleteCredentialsRequest {
@JsonIgnore private Long credentialId;
/**
- * The ID of the service principal whose credentials will be modified. Only service principal
+ * The ID of the service principal whose credential will be deleted. Only service principal
* managers can perform this action.
*/
@JsonIgnore
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsRequest.java
index 65ac47b16..485064380 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsRequest.java
@@ -14,7 +14,7 @@ public class GetCredentialsRequest {
@JsonIgnore private Long credentialId;
/**
- * The ID of the service principal whose credentials will be modified. Only service principal
+ * The ID of the service principal whose credential will be returned. Only service principal
* managers can perform this action.
*/
@JsonIgnore
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsResponse.java
index d862a7873..9b691fdd0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetCredentialsResponse.java
@@ -35,11 +35,14 @@ public class GetCredentialsResponse {
@JsonProperty("git_username")
private String gitUsername;
- /** if the credential is the default for the given provider */
+ /**
+ * Whether this credential is the default for its Git provider. The default credential is the
+ * fallback that is used when no specific credential is selected.
+ */
@JsonProperty("is_default_for_provider")
private Boolean isDefaultForProvider;
- /** the name of the git credential, used for identification and ease of lookup */
+ /** The name of the Git credential, used for identification and ease of lookup. */
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetSecretResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetSecretResponse.java
index e763f9ea6..17f94a461 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetSecretResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GetSecretResponse.java
@@ -13,7 +13,10 @@ public class GetSecretResponse {
@JsonProperty("key")
private String key;
- /** The value of the secret in its byte representation. */
+ /**
+ * The secret value, base64-encoded. A secret written with ``string_value`` is returned as the
+ * base64 encoding of its UTF-8 bytes.
+ */
@JsonProperty("value")
private String value;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsAPI.java
index 07f0d9af3..7e313e0fc 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsAPI.java
@@ -62,7 +62,7 @@ public Iterable list(ListCredentialsRequest request) {
request, impl::list, ListCredentialsResponse::getCredentials, response -> null);
}
- /** Updates the specified Git credential. */
+ /** Updates the specified Git credential. Fields that are omitted keep their current values. */
public void update(UpdateCredentialsRequest request) {
impl.update(request);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsService.java
index d3f0d5bf1..2180fa58b 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/GitCredentialsService.java
@@ -31,6 +31,6 @@ public interface GitCredentialsService {
/** Lists the calling user's Git credentials. */
ListCredentialsResponse list(ListCredentialsRequest listCredentialsRequest);
- /** Updates the specified Git credential. */
+ /** Updates the specified Git credential. Fields that are omitted keep their current values. */
void update(UpdateCredentialsRequest updateCredentialsRequest);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutSecret.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutSecret.java
index 0832a2ad1..e0c111079 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutSecret.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/PutSecret.java
@@ -9,7 +9,7 @@
@Generated
public class PutSecret {
- /** If specified, value will be stored as bytes. */
+ /** The secret value as raw bytes. The bytes must be base64-encoded in the JSON request body. */
@JsonProperty("bytes_value")
private String bytesValue;
@@ -17,11 +17,11 @@ public class PutSecret {
@JsonProperty("key")
private String key;
- /** The name of the scope to which the secret will be associated with. */
+ /** The name of the scope to store the secret in. */
@JsonProperty("scope")
private String scope;
- /** If specified, note that the value will be stored in UTF-8 (MB4) form. */
+ /** The secret value as text. The server stores it as the UTF-8 encoding of the string. */
@JsonProperty("string_value")
private String stringValue;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretMetadata.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretMetadata.java
index 61b3d8e06..105faa19f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretMetadata.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/SecretMetadata.java
@@ -17,7 +17,7 @@ public class SecretMetadata {
@JsonProperty("key")
private String key;
- /** The last updated timestamp (in milliseconds) for the secret. */
+ /** The time the secret was last written, in milliseconds since the Unix epoch. */
@JsonProperty("last_updated_timestamp")
private Long lastUpdatedTimestamp;
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 a87b05966..320ab756f 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
@@ -117,12 +117,6 @@ public void deleteScope(DeleteScope request) {
* Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE``
* permission on the Secret Scope.
*
- * Example request:
- *
- *
.. code::
- *
- *
{ "scope": "my-secret-scope", "key": "my-secret-key" }
- *
*
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
@@ -160,30 +154,19 @@ public GetSecretResponse getSecret(String scope, String key) {
}
/**
- * Gets a secret for a given key and scope. This API can only be called from the DBUtils
- * interface. Users need the READ permission to make this call.
+ * Gets the bytes representation of a secret value for the specified scope and key. Users need the
+ * READ permission to make this call.
*
- *
Example response:
- *
- *
.. code::
- *
- *
{ "key": "my-string-key", "value": }
- *
- * Note that the secret value returned is in bytes. The interpretation of the bytes is
- * determined by the caller in DBUtils and the type the data is decoded into.
+ *
The secret value is returned as bytes regardless of whether it was written with
+ * ``string_value`` or ``bytes_value``, so the caller decides how to decode it. Values returned by
+ * this API are not redacted.
*
*
Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists. Throws
- * ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
- *
- *
Note: This is explicitly an undocumented API. It also doesn't need to be supported for the
- * /preview prefix, because it's not a customer-facing API (i.e. only used for DBUtils SecretUtils
- * to fetch secrets).
- *
- *
Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists. Throws
- * ``BAD_REQUEST`` if normal user calls get secret outside of a notebook. AKV specific errors:
- * Throws ``INVALID_PARAMETER_VALUE`` if secret name is not alphanumeric or too long. Throws
- * ``PERMISSION_DENIED`` if secret manager cannot access AKV with 403 error Throws
- * ``MALFORMED_REQUEST`` if secret manager cannot access AKV with any other 4xx error
+ * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Azure Key
+ * Vault-backed scopes can also return the following errors: Throws ``INVALID_PARAMETER_VALUE`` if
+ * the secret name is not alphanumeric or is too long. Throws ``PERMISSION_DENIED`` if Databricks
+ * cannot access the key vault (HTTP 403). Throws ``MALFORMED_REQUEST`` if Databricks cannot
+ * access the key vault with any other 4xx error.
*/
public GetSecretResponse getSecret(GetSecretRequest request) {
return impl.getSecret(request);
@@ -238,15 +221,6 @@ public Iterable listSecrets(String scope) {
* Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret
* data cannot be retrieved using this API. Users need the READ permission to make this call.
*
- * Example response:
- *
- *
.. code::
- *
- *
{ "secrets": [ { "key": "my-string-key"", "last_updated_timestamp": "1520467595000" }, {
- * "key": "my-byte-key", "last_updated_timestamp": "1520467595000" }, ] }
- *
- *
The lastUpdatedTimestamp returned is in milliseconds since epoch.
- *
*
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.
*/
@@ -299,14 +273,8 @@ public void putAcl(PutAcl request) {
* and cannot exceed 128 characters. The maximum allowed secret value size is 128 KB. The maximum
* number of secrets in a given scope is 1000.
*
- *
Example request:
- *
- *
.. code::
- *
- *
{ "scope": "my-databricks-scope", "key": "my-string-key", "string_value": "foobar" }
- *
- *
The input fields "string_value" or "bytes_value" specify the type of the secret, which will
- * determine the value returned when the secret value is requested. Exactly one must be specified.
+ *
Exactly one of ``string_value`` or ``bytes_value`` must be specified. The server stores both
+ * kinds of value as bytes and does not record which one was used.
*
*
Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws
* ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is exceeded. Throws
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 d189d8f7e..ce21a5b7e 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
@@ -93,12 +93,6 @@ public interface SecretsService {
* Deletes the secret stored in this secret scope. You must have ``WRITE`` or ``MANAGE``
* permission on the Secret Scope.
*
- *
Example request:
- *
- *
.. code::
- *
- *
{ "scope": "my-secret-scope", "key": "my-secret-key" }
- *
*
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
@@ -124,30 +118,19 @@ public interface SecretsService {
AclItem getAcl(GetAclRequest getAclRequest);
/**
- * Gets a secret for a given key and scope. This API can only be called from the DBUtils
- * interface. Users need the READ permission to make this call.
+ * Gets the bytes representation of a secret value for the specified scope and key. Users need the
+ * READ permission to make this call.
*
- *
Example response:
- *
- *
.. code::
- *
- *
{ "key": "my-string-key", "value": }
- *
- * Note that the secret value returned is in bytes. The interpretation of the bytes is
- * determined by the caller in DBUtils and the type the data is decoded into.
+ *
The secret value is returned as bytes regardless of whether it was written with
+ * ``string_value`` or ``bytes_value``, so the caller decides how to decode it. Values returned by
+ * this API are not redacted.
*
*
Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret or secret scope exists. Throws
- * ``PERMISSION_DENIED`` if the user does not have permission to make this API call.
- *
- *
Note: This is explicitly an undocumented API. It also doesn't need to be supported for the
- * /preview prefix, because it's not a customer-facing API (i.e. only used for DBUtils SecretUtils
- * to fetch secrets).
- *
- *
Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope or secret exists. Throws
- * ``BAD_REQUEST`` if normal user calls get secret outside of a notebook. AKV specific errors:
- * Throws ``INVALID_PARAMETER_VALUE`` if secret name is not alphanumeric or too long. Throws
- * ``PERMISSION_DENIED`` if secret manager cannot access AKV with 403 error Throws
- * ``MALFORMED_REQUEST`` if secret manager cannot access AKV with any other 4xx error
+ * ``PERMISSION_DENIED`` if the user does not have permission to make this API call. Azure Key
+ * Vault-backed scopes can also return the following errors: Throws ``INVALID_PARAMETER_VALUE`` if
+ * the secret name is not alphanumeric or is too long. Throws ``PERMISSION_DENIED`` if Databricks
+ * cannot access the key vault (HTTP 403). Throws ``MALFORMED_REQUEST`` if Databricks cannot
+ * access the key vault with any other 4xx error.
*/
GetSecretResponse getSecret(GetSecretRequest getSecretRequest);
@@ -186,15 +169,6 @@ public interface SecretsService {
* Lists the secret keys that are stored at this scope. This is a metadata-only operation; secret
* data cannot be retrieved using this API. Users need the READ permission to make this call.
*
- *
Example response:
- *
- *
.. code::
- *
- *
{ "secrets": [ { "key": "my-string-key"", "last_updated_timestamp": "1520467595000" }, {
- * "key": "my-byte-key", "last_updated_timestamp": "1520467595000" }, ] }
- *
- *
The lastUpdatedTimestamp returned is in milliseconds since epoch.
- *
*
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.
*/
@@ -242,14 +216,8 @@ public interface SecretsService {
* and cannot exceed 128 characters. The maximum allowed secret value size is 128 KB. The maximum
* number of secrets in a given scope is 1000.
*
- *
Example request:
- *
- *
.. code::
- *
- *
{ "scope": "my-databricks-scope", "key": "my-string-key", "string_value": "foobar" }
- *
- *
The input fields "string_value" or "bytes_value" specify the type of the secret, which will
- * determine the value returned when the secret value is requested. Exactly one must be specified.
+ *
Exactly one of ``string_value`` or ``bytes_value`` must be specified. The server stores both
+ * kinds of value as bytes and does not record which one was used.
*
*
Throws ``RESOURCE_DOES_NOT_EXIST`` if no such secret scope exists. Throws
* ``RESOURCE_LIMIT_EXCEEDED`` if maximum number of secrets in scope is exceeded. Throws
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateCredentialsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateCredentialsRequest.java
index 92e8a8f1e..086e82eef 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateCredentialsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/workspace/UpdateCredentialsRequest.java
@@ -26,7 +26,8 @@ public class UpdateCredentialsRequest {
* Git provider. This field is case-insensitive. The available Git providers are `gitHub`,
* `bitbucketCloud`, `gitLab`, `azureDevOpsServices` (Azure DevOps Services, including Microsoft
* Entra ID authentication), `gitHubEnterprise`, `bitbucketServer` (Bitbucket Data Center),
- * `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`.
+ * `gitLabEnterpriseEdition` (GitLab Self-Managed), and `awsCodeCommit`. Must match the Git
+ * provider of the existing credential; the provider cannot be changed.
*/
@JsonProperty("git_provider")
private String gitProvider;
@@ -40,11 +41,17 @@ public class UpdateCredentialsRequest {
@JsonProperty("git_username")
private String gitUsername;
- /** if the credential is the default for the given provider */
+ /**
+ * Set to true to make this credential the default for its Git provider, replacing the current
+ * default. Cannot be set to false; make another credential the default instead.
+ */
@JsonProperty("is_default_for_provider")
private Boolean isDefaultForProvider;
- /** the name of the git credential, used for identification and ease of lookup */
+ /**
+ * The name of the Git credential, used for identification and ease of lookup. It must not exceed
+ * 100 characters.
+ */
@JsonProperty("name")
private String name;
diff --git a/examples/docs/pom.xml b/examples/docs/pom.xml
index d1bc72cc9..6800dffda 100644
--- a/examples/docs/pom.xml
+++ b/examples/docs/pom.xml
@@ -24,7 +24,7 @@
com.databricks
databricks-sdk-java
- 0.181.0
+ 0.182.0
diff --git a/examples/spring-boot-oauth-u2m-demo/pom.xml b/examples/spring-boot-oauth-u2m-demo/pom.xml
index d985f933f..0a26a42d6 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.181.0
+ 0.182.0
diff --git a/lockfile.json b/lockfile.json
index b97ec4030..eac264926 100644
--- a/lockfile.json
+++ b/lockfile.json
@@ -1,7 +1,7 @@
{
"artifactId": "databricks-sdk-parent",
"groupId": "com.databricks",
- "version": "0.181.0",
+ "version": "0.182.0",
"lockFileVersion": 1,
"dependencies": [],
"mavenPlugins": [],
diff --git a/pom.xml b/pom.xml
index bd7d17cbf..bc5396ead 100644
--- a/pom.xml
+++ b/pom.xml
@@ -4,7 +4,7 @@
4.0.0
com.databricks
databricks-sdk-parent
- 0.181.0
+ 0.182.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 82ac9c0cd..b6dab447d 100644
--- a/shaded/pom.xml
+++ b/shaded/pom.xml
@@ -4,7 +4,7 @@
4.0.0
- 0.181.0
+ 0.182.0
com.databricks