actionConfigurations;
@@ -26,7 +26,8 @@ public class CreateBudgetConfigurationBudgetAlertConfigurations {
/**
* The threshold for the budget alert to determine if it is in a triggered state. The number is
- * evaluated based on `quantity_type`.
+ * evaluated based on `quantity_type`. A decimal number passed as a string, from 0 to
+ * 1,000,000,000.
*/
@JsonProperty("quantity_threshold")
private String quantityThreshold;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBudgetConfigurationResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBudgetConfigurationResponse.java
index bc3c78ad4..23cc055b9 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBudgetConfigurationResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/GetBudgetConfigurationResponse.java
@@ -9,7 +9,7 @@
@Generated
public class GetBudgetConfigurationResponse {
- /** */
+ /** The requested budget configuration. */
@JsonProperty("budget")
private BudgetConfiguration budget;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationBudget.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationBudget.java
index 5445463b4..71f829219 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationBudget.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationBudget.java
@@ -8,6 +8,11 @@
import java.util.Collection;
import java.util.Objects;
+/**
+ * A budget tracks the spend of your account, or of the workspaces and custom tags selected by its
+ * filter, against one or more alert thresholds. Spend is measured in US dollars at list price. For
+ * an overview, see https://docs.databricks.com/en/admin/account-settings/budgets.html.
+ */
@Generated
public class UpdateBudgetConfigurationBudget {
/** Databricks account ID. */
@@ -39,7 +44,8 @@ public class UpdateBudgetConfigurationBudget {
/**
* Configured filters for this budget. These are applied to your account's usage to limit the
* scope of what is considered for this budget. Leave empty to include all usage for this account.
- * All provided filters must be matched for usage to be included.
+ * All provided filters must be matched for usage to be included. The filter cannot be changed
+ * after the budget is created. To change it, delete the budget and create a new one.
*/
@JsonProperty("filter")
private BudgetConfigurationFilter filter;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationRequest.java
index 94f800b99..36e56ded4 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/billing/UpdateBudgetConfigurationRequest.java
@@ -10,7 +10,11 @@
@Generated
public class UpdateBudgetConfigurationRequest {
- /** The updated budget. This will overwrite the budget specified by the budget ID. */
+ /**
+ * The updated budget. This will overwrite the budget specified by the budget ID. Alerts and
+ * actions are matched by ID: those omitted from the request are removed, and those without an ID
+ * are created.
+ */
@JsonProperty("budget")
private UpdateBudgetConfigurationBudget budget;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalMetadataRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalMetadataRequest.java
index f1055606d..39bec1d4d 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalMetadataRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/DeleteExternalMetadataRequest.java
@@ -9,7 +9,7 @@
@Generated
public class DeleteExternalMetadataRequest {
- /** */
+ /** Name of the external metadata object to delete. */
@JsonIgnore private String name;
public DeleteExternalMetadataRequest setName(String name) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadata.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadata.java
index eb20f8f9a..2103b6b32 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadata.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadata.java
@@ -9,9 +9,22 @@
import java.util.Map;
import java.util.Objects;
+/**
+ * Metadata about an object that lives outside of Databricks, such as a Kafka topic, a Tableau
+ * dashboard, or a Salesforce table. An external metadata object is a Unity Catalog securable that
+ * can be the source or the target of external lineage relationships, so that data flows into and
+ * out of Databricks appear in the Unity Catalog lineage graph. See [External lineage].
+ *
+ * [External lineage]:
+ * https://docs.databricks.com/aws/en/data-governance/unity-catalog/external-lineage
+ */
@Generated
public class ExternalMetadata {
- /** List of columns associated with the external metadata object. */
+ /**
+ * Names of the columns of the object, used for column-level mappings in external lineage
+ * relationships. Column names must be unique within the list, and the combined size of all column
+ * names is limited.
+ */
@JsonProperty("columns")
private Collection columns;
@@ -23,15 +36,24 @@ public class ExternalMetadata {
@JsonProperty("created_by")
private String createdBy;
- /** User-provided free-form text description. */
+ /**
+ * User-provided free-form text description of the object. The description must not exceed 5000
+ * characters.
+ */
@JsonProperty("description")
private String description;
- /** Type of entity within the external system. */
+ /**
+ * Type of the object within the external system, such as a table, a report, or a dashboard. The
+ * value is free-form text of at most 255 characters.
+ */
@JsonProperty("entity_type")
private String entityType;
- /** Unique identifier of the external metadata object. */
+ /**
+ * Unique identifier of the external metadata object. The ID is a UUID that the system assigns on
+ * creation.
+ */
@JsonProperty("id")
private String id;
@@ -39,19 +61,35 @@ public class ExternalMetadata {
@JsonProperty("metastore_id")
private String metastoreId;
- /** Name of the external metadata object. */
+ /**
+ * Name of the external metadata object. The name is unique within the metastore, must follow the
+ * [Unity Catalog naming requirements], and is stored in lowercase. It cannot be changed after
+ * creation, and external lineage relationships refer to the object by this name.
+ *
+ * [Unity Catalog naming requirements]:
+ * https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements
+ */
@JsonProperty("name")
private String name;
- /** Owner of the external metadata object. */
+ /**
+ * Owner of the external metadata object. Defaults to the creator. To change the owner, send an
+ * update whose update mask includes `owner`.
+ */
@JsonProperty("owner")
private String owner;
- /** A map of key-value properties attached to the external metadata object. */
+ /**
+ * Key-value properties attached to the object. Keys and values must be non-empty, and the
+ * combined length of all keys and values must not exceed 5000 characters.
+ */
@JsonProperty("properties")
private Map properties;
- /** Type of external system. */
+ /**
+ * Type of the external system that holds the object. Use `OTHER` for a system that is not in the
+ * list.
+ */
@JsonProperty("system_type")
private SystemType systemType;
@@ -63,7 +101,10 @@ public class ExternalMetadata {
@JsonProperty("updated_by")
private String updatedBy;
- /** URL associated with the external metadata object. */
+ /**
+ * URL of the object in the external system. When set, lineage graph viewers can follow it to the
+ * external asset. The URL must not exceed 2048 characters.
+ */
@JsonProperty("url")
private String url;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java
index c2b25c013..110efa281 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataAPI.java
@@ -45,9 +45,10 @@ public void deleteExternalMetadata(String name) {
}
/**
- * Deletes the external metadata object that matches the supplied name. The caller must be a
- * metastore admin, the owner of the external metadata object, or a user that has the **MANAGE**
- * privilege.
+ * Deletes the external metadata object that matches the supplied name. Every external lineage
+ * relationship in which the object is the source or the target is deleted with it. The caller
+ * must be a metastore admin, the owner of the external metadata object, or a user that has the
+ * **MANAGE** privilege.
*/
public void deleteExternalMetadata(DeleteExternalMetadataRequest request) {
impl.deleteExternalMetadata(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataService.java
index 40bb19ad4..1df40d583 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ExternalMetadataService.java
@@ -26,9 +26,10 @@ ExternalMetadata createExternalMetadata(
CreateExternalMetadataRequest createExternalMetadataRequest);
/**
- * Deletes the external metadata object that matches the supplied name. The caller must be a
- * metastore admin, the owner of the external metadata object, or a user that has the **MANAGE**
- * privilege.
+ * Deletes the external metadata object that matches the supplied name. Every external lineage
+ * relationship in which the object is the source or the target is deleted with it. The caller
+ * must be a metastore admin, the owner of the external metadata object, or a user that has the
+ * **MANAGE** privilege.
*/
void deleteExternalMetadata(DeleteExternalMetadataRequest deleteExternalMetadataRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalMetadataRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalMetadataRequest.java
index b797fe594..ddbe0e891 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalMetadataRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/GetExternalMetadataRequest.java
@@ -9,7 +9,7 @@
@Generated
public class GetExternalMetadataRequest {
- /** */
+ /** Name of the external metadata object to get. */
@JsonIgnore private String name;
public GetExternalMetadataRequest setName(String name) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalMetadataRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalMetadataRequest.java
index bf2dff05b..45965d6d0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalMetadataRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/ListExternalMetadataRequest.java
@@ -12,7 +12,7 @@
public class ListExternalMetadataRequest {
/**
* Specifies the maximum number of external metadata objects to return in a single response. The
- * value must be less than or equal to 1000.
+ * value must be less than or equal to 1000. Defaults to 1000 when omitted.
*/
@JsonIgnore
@QueryParam("page_size")
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java
index 890161e0e..9f1fcccaa 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/catalog/UpdateExternalMetadataRequest.java
@@ -15,19 +15,19 @@ public class UpdateExternalMetadataRequest {
@JsonProperty("external_metadata")
private ExternalMetadata externalMetadata;
- /** Name of the external metadata object. */
+ /**
+ * Name of the external metadata object. The name is unique within the metastore, must follow the
+ * [Unity Catalog naming requirements], and is stored in lowercase. It cannot be changed after
+ * creation, and external lineage relationships refer to the object by this name.
+ *
+ * [Unity Catalog naming requirements]:
+ * https://docs.databricks.com/aws/en/data-governance/unity-catalog/requirements#naming-requirements
+ */
@JsonIgnore private String name;
/**
- * 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.
+ * Comma-separated list of the fields to update, for example `description,properties`. Only the
+ * listed fields change. The other fields keep their current values. The mask must not be empty.
*/
@JsonIgnore
@QueryParam("update_mask")
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 cb6ad7892..9dc838041 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
@@ -18,8 +18,8 @@ public class ClusterAttributes {
/**
* Automatically terminates the cluster after it is inactive for this time in minutes. If not set,
* this cluster will not be automatically terminated. If specified, the threshold must be between
- * 10 and 10000 minutes. Users can also set this value to 0 to explicitly disable automatic
- * termination.
+ * 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable
+ * automatic termination.
*/
@JsonProperty("autotermination_minutes")
private Long autoterminationMinutes;
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 4a8d8a35e..16101a236 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
@@ -22,8 +22,8 @@ public class ClusterDetails {
/**
* Automatically terminates the cluster after it is inactive for this time in minutes. If not set,
* this cluster will not be automatically terminated. If specified, the threshold must be between
- * 10 and 10000 minutes. Users can also set this value to 0 to explicitly disable automatic
- * termination.
+ * 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable
+ * automatic termination.
*/
@JsonProperty("autotermination_minutes")
private Long autoterminationMinutes;
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 2df952a1e..4bc2503ab 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
@@ -32,8 +32,8 @@ public class ClusterSpec {
/**
* Automatically terminates the cluster after it is inactive for this time in minutes. If not set,
* this cluster will not be automatically terminated. If specified, the threshold must be between
- * 10 and 10000 minutes. Users can also set this value to 0 to explicitly disable automatic
- * termination.
+ * 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable
+ * automatic termination.
*/
@JsonProperty("autotermination_minutes")
private Long autoterminationMinutes;
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 8eac3936f..d59a0926f 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
@@ -28,8 +28,8 @@ public class CreateCluster {
/**
* Automatically terminates the cluster after it is inactive for this time in minutes. If not set,
* this cluster will not be automatically terminated. If specified, the threshold must be between
- * 10 and 10000 minutes. Users can also set this value to 0 to explicitly disable automatic
- * termination.
+ * 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable
+ * automatic termination.
*/
@JsonProperty("autotermination_minutes")
private Long autoterminationMinutes;
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 0d8be401c..d9abb752a 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
@@ -28,8 +28,8 @@ public class EditCluster {
/**
* Automatically terminates the cluster after it is inactive for this time in minutes. If not set,
* this cluster will not be automatically terminated. If specified, the threshold must be between
- * 10 and 10000 minutes. Users can also set this value to 0 to explicitly disable automatic
- * termination.
+ * 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable
+ * automatic termination.
*/
@JsonProperty("autotermination_minutes")
private Long autoterminationMinutes;
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 557e15691..86488b11b 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
@@ -21,8 +21,8 @@ public class EnforcePolicyComplianceForClusterResponseClusterSettings {
/**
* Automatically terminates the cluster after it is inactive for this time in minutes. If not set,
* this cluster will not be automatically terminated. If specified, the threshold must be between
- * 10 and 10000 minutes. Users can also set this value to 0 to explicitly disable automatic
- * termination.
+ * 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable
+ * automatic termination.
*/
@JsonProperty("autotermination_minutes")
private Long autoterminationMinutes;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java
index 413dc1d0a..8df449b67 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/GetInstancePool.java
@@ -39,11 +39,9 @@ public class GetInstancePool {
*
*
- Vendor: Databricks
*
- *
- InstancePoolCreator:
+ * - DatabricksInstancePoolCreatorId:
*
- * - InstancePoolName:
- *
- * - InstancePoolId:
+ * - DatabricksInstancePoolId:
*/
@JsonProperty("default_tags")
private Map defaultTags;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolAndStats.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolAndStats.java
index 2db4d4309..ee5511dca 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolAndStats.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/compute/InstancePoolAndStats.java
@@ -39,11 +39,9 @@ public class InstancePoolAndStats {
*
* - Vendor: Databricks
*
- *
- InstancePoolCreator:
+ * - DatabricksInstancePoolCreatorId:
*
- * - InstancePoolName:
- *
- * - InstancePoolId:
+ * - DatabricksInstancePoolId:
*/
@JsonProperty("default_tags")
private Map defaultTags;
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 06efdc67e..7e8e2b72b 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
@@ -21,8 +21,8 @@ public class UpdateClusterResource {
/**
* Automatically terminates the cluster after it is inactive for this time in minutes. If not set,
* this cluster will not be automatically terminated. If specified, the threshold must be between
- * 10 and 10000 minutes. Users can also set this value to 0 to explicitly disable automatic
- * termination.
+ * 10 and 43200 minutes (30 days). Users can also set this value to 0 to explicitly disable
+ * automatic termination.
*/
@JsonProperty("autotermination_minutes")
private Long autoterminationMinutes;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ContinuousTriggerState.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ContinuousTriggerState.java
index 3c9a3403a..e4a4b4774 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ContinuousTriggerState.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/ContinuousTriggerState.java
@@ -9,15 +9,20 @@
@Generated
public class ContinuousTriggerState {
- /** */
+ /**
+ * The number of consecutive unsuccessful runs. Resets to `0` after a healthy run and determines
+ * the exponential backoff before the next run.
+ */
@JsonProperty("consecutive_failures")
private Long consecutiveFailures;
- /** */
+ /**
+ * Whether the trigger is delaying the next run with exponential backoff after repeated failures.
+ */
@JsonProperty("is_backing_off")
private Boolean isBackingOff;
- /** */
+ /** The time at which the trigger next attempts to start a run, in epoch milliseconds. */
@JsonProperty("next_attempt_ms")
private Long nextAttemptMs;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java
index 6378777fb..a9ad3b914 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/CreateJob.java
@@ -113,7 +113,7 @@ public class CreateJob {
@JsonProperty("git_source")
private GitSource gitSource;
- /** */
+ /** An optional set of health rules that can be defined for this job. */
@JsonProperty("health")
private JobsHealthRules health;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/GitSource.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/GitSource.java
index 27bb17bee..417c78ce6 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/GitSource.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/GitSource.java
@@ -40,7 +40,10 @@ public class GitSource {
@JsonProperty("git_provider")
private GitProvider gitProvider;
- /** */
+ /**
+ * Read-only state of the remote repository at the time the job was run. This field is only
+ * included on job runs.
+ */
@JsonProperty("git_snapshot")
private GitSnapshot gitSnapshot;
@@ -61,7 +64,10 @@ public class GitSource {
@JsonProperty("job_source")
private JobSource jobSource;
- /** */
+ /**
+ * Sparse checkout settings for the repository. When set, only the directories listed in
+ * `patterns` are checked out.
+ */
@JsonProperty("sparse_checkout")
private SparseCheckout sparseCheckout;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobCompletionTriggerConfigurationMonitoredJob.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobCompletionTriggerConfigurationMonitoredJob.java
index 45c717d05..d1824076b 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobCompletionTriggerConfigurationMonitoredJob.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobCompletionTriggerConfigurationMonitoredJob.java
@@ -17,7 +17,7 @@ public class JobCompletionTriggerConfigurationMonitoredJob {
/**
* The ID of the workspace containing the upstream job. This can differ from the caller's
* workspace and downstream services enforce correct entitlements and CAN_VIEW permissions for the
- * user + job combination. SDR: https://databricks.atlassian.net/browse/SDR-5267
+ * user + job combination.
*/
@JsonProperty("workspace_id")
private String workspaceId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobEnvironment.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobEnvironment.java
index c54674370..619718e8e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobEnvironment.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobEnvironment.java
@@ -13,7 +13,10 @@ public class JobEnvironment {
@JsonProperty("environment_key")
private String environmentKey;
- /** */
+ /**
+ * The environment specification, including the environment version and the dependencies to
+ * install before a task runs.
+ */
@JsonProperty("spec")
private com.databricks.sdk.service.compute.Environment spec;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java
index e52bdd76d..d97071f1e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobSettings.java
@@ -109,7 +109,7 @@ public class JobSettings {
@JsonProperty("git_source")
private GitSource gitSource;
- /** */
+ /** An optional set of health rules that can be defined for this job. */
@JsonProperty("health")
private JobsHealthRules health;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRule.java
index 65f55a858..c76e051bb 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRule.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRule.java
@@ -9,11 +9,23 @@
@Generated
public class JobsHealthRule {
- /** */
+ /**
+ * Specifies the health metric that is being evaluated for a particular health rule.
+ *
+ * * `RUN_DURATION_SECONDS`: Expected total time for a run in seconds. *
+ * `STREAMING_BACKLOG_BYTES`: An estimate of the maximum bytes of data waiting to be consumed
+ * across all streams. This metric is in Public Preview. * `STREAMING_BACKLOG_RECORDS`: An
+ * estimate of the maximum offset lag across all streams. This metric is in Public Preview. *
+ * `STREAMING_BACKLOG_SECONDS`: An estimate of the maximum consumer delay across all streams. This
+ * metric is in Public Preview. * `STREAMING_BACKLOG_FILES`: An estimate of the maximum number of
+ * outstanding files across all streams. This metric is in Public Preview.
+ */
@JsonProperty("metric")
private JobsHealthMetric metric;
- /** */
+ /**
+ * Specifies the operator used to compare the health metric value with the specified threshold.
+ */
@JsonProperty("op")
private JobsHealthOperator op;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRules.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRules.java
index 45f3e3015..6cdaf0751 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRules.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/JobsHealthRules.java
@@ -11,7 +11,7 @@
/** An optional set of health rules that can be defined for this job. */
@Generated
public class JobsHealthRules {
- /** */
+ /** The health rules to evaluate for each run. */
@JsonProperty("rules")
private Collection rules;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PerTriggerState.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PerTriggerState.java
index d04ef1694..a15abb412 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PerTriggerState.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PerTriggerState.java
@@ -15,19 +15,19 @@
*/
@Generated
public class PerTriggerState {
- /** */
+ /** State of the continuous trigger. */
@JsonProperty("continuous")
private ContinuousTriggerState continuous;
- /** */
+ /** State of the file arrival trigger. */
@JsonProperty("file_arrival")
private FileArrivalTriggerState fileArrival;
- /** */
+ /** State of the job completion trigger. */
@JsonProperty("job_completion")
private JobCompletionTriggerState jobCompletion;
- /** */
+ /** State of the model trigger. */
@JsonProperty("model")
private ModelTriggerState model;
@@ -35,11 +35,11 @@ public class PerTriggerState {
@JsonProperty("pause_status")
private PauseStatus pauseStatus;
- /** */
+ /** State of the periodic trigger. */
@JsonProperty("periodic")
private PeriodicTriggerState periodic;
- /** */
+ /** State of the cron schedule trigger. */
@JsonProperty("schedule")
private ScheduleTriggerState schedule;
@@ -47,7 +47,7 @@ public class PerTriggerState {
@JsonProperty("sql_condition")
private SqlConditionState sqlCondition;
- /** */
+ /** State of the table update trigger. */
@JsonProperty("table_update")
private TableTriggerState tableUpdate;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PeriodicTriggerState.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PeriodicTriggerState.java
index b055a7e88..7a4ad0d2c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PeriodicTriggerState.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/PeriodicTriggerState.java
@@ -9,7 +9,10 @@
@Generated
public class PeriodicTriggerState {
- /** */
+ /**
+ * The time of the next scheduled run, in epoch milliseconds. Only set while the trigger is not
+ * paused.
+ */
@JsonProperty("next_run_time")
private Long nextRunTime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/RunNow.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/RunNow.java
index cc19e6ab4..a13bbc5e0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/RunNow.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/RunNow.java
@@ -64,7 +64,7 @@ public class RunNow {
@JsonProperty("job_id")
private Long jobId;
- /** Job-level parameters used in the run. for example `"param": "overriding_val"` */
+ /** Job-level parameters used in the run, for example `"param": "overriding_val"`. */
@JsonProperty("job_parameters")
private Map jobParameters;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SparseCheckout.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SparseCheckout.java
index 193e1083d..f40005c55 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SparseCheckout.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/SparseCheckout.java
@@ -10,7 +10,10 @@
@Generated
public class SparseCheckout {
- /** List of patterns to include for sparse checkout. */
+ /**
+ * List of patterns to include for sparse checkout. Each pattern is the path of a directory
+ * relative to the repository root.
+ */
@JsonProperty("patterns")
private Collection patterns;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TableTriggerState.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TableTriggerState.java
index 871c96f44..c2f9e7555 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TableTriggerState.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TableTriggerState.java
@@ -10,7 +10,7 @@
@Generated
public class TableTriggerState {
- /** */
+ /** The last observed state of each monitored table. */
@JsonProperty("last_seen_table_states")
private Collection lastSeenTableStates;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Task.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Task.java
index 697d9a0be..9df8995c0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Task.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Task.java
@@ -133,7 +133,7 @@ public class Task {
@JsonProperty("gen_ai_compute_task")
private GenAiComputeTask genAiComputeTask;
- /** */
+ /** An optional set of health rules that can be defined for this task. */
@JsonProperty("health")
private JobsHealthRules health;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerSettings.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerSettings.java
index e5a429525..4cdce3749 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerSettings.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerSettings.java
@@ -36,7 +36,7 @@ public class TriggerSettings {
@JsonProperty("sql_condition")
private SqlConditionConfiguration sqlCondition;
- /** */
+ /** Table update trigger settings. */
@JsonProperty("table_update")
private TableUpdateTriggerConfiguration tableUpdate;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerStateProto.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerStateProto.java
index c537d2edc..f2e9737d8 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerStateProto.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/TriggerStateProto.java
@@ -9,11 +9,11 @@
@Generated
public class TriggerStateProto {
- /** */
+ /** State of the file arrival trigger. */
@JsonProperty("file_arrival")
private FileArrivalTriggerState fileArrival;
- /** */
+ /** State of the job completion trigger. */
@JsonProperty("job_completion")
private JobCompletionTriggerState jobCompletion;
@@ -29,7 +29,7 @@ public class TriggerStateProto {
@JsonProperty("sql_condition")
private SqlConditionState sqlCondition;
- /** */
+ /** State of the table update trigger. */
@JsonProperty("table")
private TableTriggerState table;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Webhook.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Webhook.java
index 270e5ae06..b87937222 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Webhook.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/jobs/Webhook.java
@@ -9,7 +9,7 @@
@Generated
public class Webhook {
- /** */
+ /** The ID of the notification destination to call. Must be a UUID. */
@JsonProperty("id")
private String id;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSyncedTableRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSyncedTableRequest.java
index a37bd66da..5143b25d1 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSyncedTableRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/CreateSyncedTableRequest.java
@@ -11,7 +11,10 @@
@Generated
public class CreateSyncedTableRequest {
- /** */
+ /**
+ * The synced table to create. Its configuration is read from spec, and its name comes from
+ * synced_table_id.
+ */
@JsonProperty("synced_table")
private SyncedTable syncedTable;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/MigrationType.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/MigrationType.java
index 455ccc028..b1cffdc7c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/MigrationType.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/MigrationType.java
@@ -8,5 +8,4 @@
@Generated
public enum MigrationType {
MIGRATION_TYPE_ONE_TIME_COPY,
- MIGRATION_TYPE_ONLINE,
}
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 bf9a2dac7..d0cacab32 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
@@ -137,7 +137,10 @@ public CreateSnapshotOperation createSnapshot(CreateSnapshotRequest request) {
return new CreateSnapshotOperation(impl, operation);
}
- /** Create a Synced Table. */
+ /**
+ * Create a Synced Table. Creates the synced table in Unity Catalog and the Postgres table on the
+ * branch, and starts the pipeline that loads the initial data from the source table.
+ */
public CreateSyncedTableOperation createSyncedTable(CreateSyncedTableRequest request) {
Operation operation = impl.createSyncedTable(request);
return new CreateSyncedTableOperation(impl, operation);
@@ -266,7 +269,11 @@ public DeleteSyncedTableOperation deleteSyncedTable(String name) {
return deleteSyncedTable(new DeleteSyncedTableRequest().setName(name));
}
- /** Delete a Synced Table. */
+ /**
+ * Delete a Synced Table. Drops the Postgres table, removes the synced table from its pipeline,
+ * and deletes it from Unity Catalog. The pipeline itself is deleted when no other synced table
+ * uses it.
+ */
public DeleteSyncedTableOperation deleteSyncedTable(DeleteSyncedTableRequest request) {
Operation operation = impl.deleteSyncedTable(request);
return new DeleteSyncedTableOperation(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 e474bfeba..416e956bc 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
@@ -87,7 +87,10 @@ Operation acknowledgeAssessmentWarnings(
*/
Operation createSnapshot(CreateSnapshotRequest createSnapshotRequest);
- /** Create a Synced Table. */
+ /**
+ * Create a Synced Table. Creates the synced table in Unity Catalog and the Postgres table on the
+ * branch, and starts the pipeline that loads the initial data from the source table.
+ */
Operation createSyncedTable(CreateSyncedTableRequest createSyncedTableRequest);
/** Deletes the specified database branch. */
@@ -139,7 +142,11 @@ Operation acknowledgeAssessmentWarnings(
*/
Operation deleteSnapshot(DeleteSnapshotRequest deleteSnapshotRequest);
- /** Delete a Synced Table. */
+ /**
+ * Delete a Synced Table. Drops the Postgres table, removes the synced table from its pipeline,
+ * and deletes it from Unity Catalog. The pipeline itself is deleted when no other synced table
+ * uses it.
+ */
Operation deleteSyncedTable(DeleteSyncedTableRequest deleteSyncedTableRequest);
/** Generate OAuth credentials for a Postgres database. */
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTable.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTable.java
index 93a4d5359..1156608b0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTable.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTable.java
@@ -8,20 +8,25 @@
import com.google.protobuf.Timestamp;
import java.util.Objects;
+/**
+ * A synced table is a read-only Postgres table that Databricks keeps up to date from a Unity
+ * Catalog source table through a managed pipeline. It is also registered in Unity Catalog under its
+ * three-part name. See https://docs.databricks.com/aws/en/oltp/projects/sync-tables.
+ */
@Generated
public class SyncedTable {
- /** */
+ /** The time when the synced table was created. */
@JsonProperty("create_time")
private Timestamp createTime;
/**
- * Output only. The Full resource name of the synced table in Postgres where (catalog, schema,
- * table) are the UC entity names.
+ * The full resource name of the synced table, where (catalog, schema, table) are the Unity
+ * Catalog names of the synced table.
*
- * Format "synced_tables/{catalog}.{schema}.{table}"
+ *
Format: "synced_tables/{catalog}.{schema}.{table}".
*
- *
For the corresponding source table in the Unity catalog look for the
- * "source_table_full_name" attribute.
+ *
For the corresponding source table in Unity Catalog, look for the "source_table_full_name"
+ * attribute.
*/
@JsonProperty("name")
private String name;
@@ -36,7 +41,11 @@ public class SyncedTable {
@JsonProperty("status")
private SyncedTableSyncedTableStatus status;
- /** The part of the name, chosen by the user when the resource was created. */
+ /**
+ * The three-part Unity Catalog name of the synced table, in the format
+ * "{catalog}.{schema}.{table}". It is the synced_table_id that was used to create the synced
+ * table and the last component of name.
+ */
@JsonProperty("synced_table_id")
private String syncedTableId;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTablePosition.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTablePosition.java
index f9d6620c5..45d6c34b2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTablePosition.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTablePosition.java
@@ -10,7 +10,7 @@
@Generated
public class SyncedTablePosition {
- /** */
+ /** The source Delta table version that the last successful sync read. */
@JsonProperty("delta_table_sync_info")
private DeltaTableSyncInfo deltaTableSyncInfo;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableSpec.java
index e1c14fc64..282e6be5a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableSpec.java
@@ -19,9 +19,12 @@ public class SyncedTableSyncedTableSpec {
private Boolean acceleratedSync;
/**
- * The full resource name the branch associated with the table.
+ * The full resource name of the branch that contains the synced table.
*
*
Format: "projects/{project_id}/branches/{branch_id}".
+ *
+ *
A value must be specified when creating a synced table inside a standard catalog. Inside a
+ * Lakebase catalog it can be omitted, and if specified it must match the branch of that catalog.
*/
@JsonProperty("branch")
private String branch;
@@ -37,10 +40,11 @@ public class SyncedTableSyncedTableSpec {
private Boolean createDatabaseObjectsIfMissing;
/**
- * ID of an existing pipeline to bin-pack this synced table into. At most one of
- * existing_pipeline_id and new_pipeline_spec should be defined.
+ * ID of an existing pipeline to bin-pack this synced table into. The pipeline must be a synced
+ * table pipeline that runs continuously if and only if scheduling_policy is CONTINUOUS. At most
+ * one of existing_pipeline_id and new_pipeline_spec should be defined.
*
- *
The pipeline used for the synced table is returned via the top level pipeline_id attribute.
+ *
The pipeline used for the synced table is returned in status.pipeline_id.
*/
@JsonProperty("existing_pipeline_id")
private String existingPipelineId;
@@ -53,28 +57,30 @@ public class SyncedTableSyncedTableSpec {
* Specification for creating a new pipeline. At most one of existing_pipeline_id and
* new_pipeline_spec should be defined.
*
- *
The pipeline used for the synced table is returned via the top level pipeline_id attribute.
+ *
The pipeline used for the synced table is returned in status.pipeline_id.
*/
@JsonProperty("new_pipeline_spec")
private NewPipelineSpec newPipelineSpec;
/**
- * The Postgres database name where the synced table will be created in.
- *
- *
If this synced table is created inside a Lakebase Catalog, this attribute can be omitted on
- * creation and is inferred from the postgres_database associated with the Lakebase Catalog. If
- * specified when inside a Lakebase Catalog, the value must match.
- *
- *
A value must be specified when creating a synced table inside a Standard Catalog.
+ * The name of the Postgres database where the synced table is created. A value must be specified
+ * on creation. If the synced table is created inside a Lakebase catalog, the value must match the
+ * Postgres database of that catalog.
*/
@JsonProperty("postgres_database")
private String postgresDatabase;
- /** Primary Key columns to be used for data insert/update in the destination. */
+ /**
+ * Primary Key columns to be used for data insert/update in the destination. At least one column
+ * must be specified.
+ */
@JsonProperty("primary_key_columns")
private Collection primaryKeyColumns;
- /** Scheduling policy of the underlying pipeline. */
+ /**
+ * Scheduling policy of the underlying pipeline. A value must be specified on creation. See
+ * https://docs.databricks.com/aws/en/oltp/projects/sync-tables for how to choose a sync mode.
+ */
@JsonProperty("scheduling_policy")
private SyncedTableSyncedTableSpecSyncedTableSchedulingPolicy schedulingPolicy;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableStatus.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableStatus.java
index e7dc081bc..6c336d8d0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableStatus.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/postgres/SyncedTableSyncedTableStatus.java
@@ -33,7 +33,10 @@ public class SyncedTableSyncedTableStatus {
@JsonProperty("message")
private String message;
- /** */
+ /**
+ * Progress of the sync that is currently running, either the initial data load or an update of a
+ * triggered or snapshot synced table.
+ */
@JsonProperty("ongoing_sync_progress")
private SyncedTablePipelineProgress ongoingSyncProgress;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/CustomerFacingIngressNetworkPolicyPrivateIngressRule.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/CustomerFacingIngressNetworkPolicyPrivateIngressRule.java
index 4123e0f61..63739dc6c 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/CustomerFacingIngressNetworkPolicyPrivateIngressRule.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/settings/CustomerFacingIngressNetworkPolicyPrivateIngressRule.java
@@ -15,9 +15,7 @@
public class CustomerFacingIngressNetworkPolicyPrivateIngressRule {
/**
* The authenticated identity the request must match. When unset, the rule matches all users and
- * service principals. On the account-level network policy, scoping to specific identities is not
- * currently supported, so this field must be unset (the rule matches all users and service
- * principals).
+ * service principals.
*/
@JsonProperty("authentication")
private CustomerFacingIngressNetworkPolicyAuthentication authentication;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateVectorIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateVectorIndexRequest.java
index f653abbc2..c458234ab 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateVectorIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/CreateVectorIndexRequest.java
@@ -25,15 +25,19 @@ public class CreateVectorIndexRequest {
@JsonProperty("index_subtype")
private IndexSubtype indexSubtype;
- /** */
+ /** Type of index to create, which determines which spec field is required. */
@JsonProperty("index_type")
private VectorIndexType indexType;
- /** Name of the index */
+ /** Three-level Unity Catalog name of the index to create. */
@JsonProperty("name")
private String name;
- /** Primary key of the index */
+ /**
+ * Name of the column that uniquely identifies each row. For a Delta Sync index it is a column of
+ * the source table; for a Direct Vector Access index it must be declared in `schema_json`. It
+ * cannot be the embedding source or embedding vector column.
+ */
@JsonProperty("primary_key")
private String primaryKey;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteDataVectorIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteDataVectorIndexRequest.java
index 52cc34287..87f420fd9 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteDataVectorIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteDataVectorIndexRequest.java
@@ -14,7 +14,7 @@ public class DeleteDataVectorIndexRequest {
/** Name of the vector index where data is to be deleted. Must be a Direct Vector Access Index. */
@JsonIgnore private String indexName;
- /** List of primary keys for the data to be deleted. */
+ /** Primary keys of the rows to delete. At least one key is required. */
@JsonIgnore
@QueryParam("primary_keys")
private Collection primaryKeys;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteIndexRequest.java
index 75c97b476..437903946 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeleteIndexRequest.java
@@ -9,7 +9,7 @@
@Generated
public class DeleteIndexRequest {
- /** Name of the index */
+ /** Three-level Unity Catalog name of the index. */
@JsonIgnore private String indexName;
public DeleteIndexRequest setIndexName(String indexName) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecRequest.java
index 3f14a73b1..e3abb2f9f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecRequest.java
@@ -27,11 +27,19 @@ public class DeltaSyncVectorIndexSpecRequest {
@JsonProperty("columns_to_sync")
private Collection columnsToSync;
- /** The columns that contain the embedding source. */
+ /**
+ * The source table column whose text Databricks embeds, together with the embedding model
+ * endpoint to use. Set this for an index with Databricks-managed embeddings. Exactly one of
+ * `embedding_source_columns` or `embedding_vector_columns` must be specified unless the index
+ * subtype is `FULL_TEXT`, and only one column is supported.
+ */
@JsonProperty("embedding_source_columns")
private Collection embeddingSourceColumns;
- /** The columns that contain the embedding vectors. */
+ /**
+ * The source table column that contains precomputed embedding vectors. Set this instead of
+ * `embedding_source_columns` for an index with self-managed embeddings.
+ */
@JsonProperty("embedding_vector_columns")
private Collection embeddingVectorColumns;
@@ -52,7 +60,7 @@ public class DeltaSyncVectorIndexSpecRequest {
@JsonProperty("pipeline_type")
private PipelineType pipelineType;
- /** The name of the source table. */
+ /** Three-level Unity Catalog name of the source table that the index is synced from. */
@JsonProperty("source_table")
private String sourceTable;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecResponse.java
index 8cbf33178..02275ca55 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DeltaSyncVectorIndexSpecResponse.java
@@ -27,11 +27,19 @@ public class DeltaSyncVectorIndexSpecResponse {
@JsonProperty("columns_to_sync")
private Collection columnsToSync;
- /** The columns that contain the embedding source. */
+ /**
+ * The source table column whose text Databricks embeds, together with the embedding model
+ * endpoint to use. Set this for an index with Databricks-managed embeddings. Exactly one of
+ * `embedding_source_columns` or `embedding_vector_columns` must be specified unless the index
+ * subtype is `FULL_TEXT`, and only one column is supported.
+ */
@JsonProperty("embedding_source_columns")
private Collection embeddingSourceColumns;
- /** The columns that contain the embedding vectors. */
+ /**
+ * The source table column that contains precomputed embedding vectors. Set this instead of
+ * `embedding_source_columns` for an index with self-managed embeddings.
+ */
@JsonProperty("embedding_vector_columns")
private Collection embeddingVectorColumns;
@@ -56,7 +64,7 @@ public class DeltaSyncVectorIndexSpecResponse {
@JsonProperty("pipeline_type")
private PipelineType pipelineType;
- /** The name of the source table. */
+ /** Three-level Unity Catalog name of the source table that the index is synced from. */
@JsonProperty("source_table")
private String sourceTable;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DirectAccessVectorIndexSpec.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DirectAccessVectorIndexSpec.java
index 579c22ce3..5c6e12f3e 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DirectAccessVectorIndexSpec.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/DirectAccessVectorIndexSpec.java
@@ -10,18 +10,26 @@
@Generated
public class DirectAccessVectorIndexSpec {
- /** The columns that contain the embedding source. The format should be array[double]. */
+ /**
+ * Embedding source configuration used to embed `query_text` when the index is queried with text,
+ * naming the embedding model endpoint to use. The index stores the vectors you supply through
+ * upsert; this setting never computes embeddings for them.
+ */
@JsonProperty("embedding_source_columns")
private Collection embeddingSourceColumns;
- /** The columns that contain the embedding vectors. The format should be array[double]. */
+ /**
+ * The column that holds the embedding vectors you write to the index. Exactly one column must be
+ * specified, and `schema_json` must declare it as `array` or `array`.
+ */
@JsonProperty("embedding_vector_columns")
private Collection embeddingVectorColumns;
/**
- * The schema of the index in JSON format. Supported types are `integer`, `long`, `float`,
- * `double`, `boolean`, `string`, `date`, `timestamp`. Supported types for vector column:
- * `array`, `array`,`.
+ * JSON object that maps each column name of the index to its type, serialized to a string. The
+ * primary key and the embedding vector column must be present. Supported types are `integer`,
+ * `long`, `float`, `double`, `boolean`, `string`, `date`, `timestamp`. Supported types for vector
+ * column: `array`, `array`.
*/
@JsonProperty("schema_json")
private String schemaJson;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingSourceColumn.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingSourceColumn.java
index d60226508..1441a19cc 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingSourceColumn.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingSourceColumn.java
@@ -19,7 +19,7 @@ public class EmbeddingSourceColumn {
@JsonProperty("model_endpoint_name_for_query")
private String modelEndpointNameForQuery;
- /** Name of the column */
+ /** Name of the column that contains the text to embed. */
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingVectorColumn.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingVectorColumn.java
index dba295871..b65a49ce9 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingVectorColumn.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/EmbeddingVectorColumn.java
@@ -13,7 +13,7 @@ public class EmbeddingVectorColumn {
@JsonProperty("embedding_dimension")
private Long embeddingDimension;
- /** Name of the column */
+ /** Name of the column that contains the embedding vectors. */
@JsonProperty("name")
private String name;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/GetIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/GetIndexRequest.java
index 0390811cc..1079dead4 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/GetIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/GetIndexRequest.java
@@ -20,7 +20,7 @@ public class GetIndexRequest {
@QueryParam("ensure_reranker_compatible")
private Boolean ensureRerankerCompatible;
- /** Name of the index */
+ /** Three-level Unity Catalog name of the index. */
@JsonIgnore private String indexName;
public GetIndexRequest setEnsureRerankerCompatible(Boolean ensureRerankerCompatible) {
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListIndexesRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListIndexesRequest.java
index 01ee7f79a..9dad0cd06 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListIndexesRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListIndexesRequest.java
@@ -10,12 +10,12 @@
@Generated
public class ListIndexesRequest {
- /** Name of the endpoint */
+ /** Name of the endpoint whose indexes to list. */
@JsonIgnore
@QueryParam("endpoint_name")
private String endpointName;
- /** Token for pagination */
+ /** Page token returned by a previous call, used to get the next page of results. */
@JsonIgnore
@QueryParam("page_token")
private String pageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListVectorIndexesResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListVectorIndexesResponse.java
index 657df2e84..20531eba6 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListVectorIndexesResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/ListVectorIndexesResponse.java
@@ -17,7 +17,10 @@ public class ListVectorIndexesResponse {
@JsonProperty("next_page_token")
private String nextPageToken;
- /** */
+ /**
+ * Indexes served by the endpoint. Each entry is a summary without the index specification and
+ * status; use Get an index to retrieve them.
+ */
@JsonProperty("vector_indexes")
private Collection vectorIndexes;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/Metric.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/Metric.java
index 55b920283..164679a2a 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/Metric.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/Metric.java
@@ -11,15 +11,27 @@
/** Metric specification */
@Generated
public class Metric {
- /** Metric labels */
+ /**
+ * Labels that restrict the metric to matching series, for example to a single index.
+ * Endpoint-level metrics do not accept labels.
+ */
@JsonProperty("labels")
private Collection labels;
- /** Metric name */
+ /**
+ * Metric name. Supported metrics include: `EndpointHealthStatus`, `EndpointConcurrency`,
+ * `IndexRequestCount`, `IndexRequestLatency`, `IndexRequestErrorSourceCount`,
+ * `IndexRequestGuidanceCount`, `IndexRequestGuidancePeakRate`, `IndexIngestedRows`, and
+ * `IndexEmbeddedRows`. An unknown name is rejected with an error that lists the available metric
+ * names.
+ */
@JsonProperty("name")
private String name;
- /** Percentile for the metric */
+ /**
+ * Percentile for latency metrics, such as `IndexRequestLatency`, which require it. One of 0.5,
+ * 0.75, 0.9, 0.95, or 0.99.
+ */
@JsonProperty("percentile")
private Double percentile;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricLabel.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricLabel.java
index fdfd49e83..d3afa9928 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricLabel.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricLabel.java
@@ -10,11 +10,18 @@
/** Label for a metric */
@Generated
public class MetricLabel {
- /** Label name */
+ /**
+ * Label name, such as `error_source`, `failure_cause`, `operation`, `request_path`, `query_type`,
+ * `response_code`, or `index_name`. Supported labels depend on the metric.
+ */
@JsonProperty("name")
private String name;
- /** Label value */
+ /**
+ * Label value, as an RE2 regular expression. The label also splits the result by its values, so
+ * `.+` returns one series per value. Some labels, such as `operation`, accept only `.+`, `.*`, or
+ * listed values joined by `|`.
+ */
@JsonProperty("value")
private String value;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValue.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValue.java
index 7eca58c0d..8cfb64758 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValue.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValue.java
@@ -10,11 +10,11 @@
/** Single metric value at a specific timestamp */
@Generated
public class MetricValue {
- /** Timestamp of the metric value (milliseconds since epoch) */
+ /** Timestamp of the metric value, in seconds since the Unix epoch. */
@JsonProperty("timestamp")
private Long timestamp;
- /** Metric value */
+ /** Value of the metric at `timestamp`. */
@JsonProperty("value")
private Double value;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValues.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValues.java
index 2b2e9eaad..7ad424df9 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValues.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MetricValues.java
@@ -11,11 +11,13 @@
/** Collection of metric values for a specific metric */
@Generated
public class MetricValues {
- /** Metric specification */
+ /**
+ * The metric this time series was computed for, including the labels that identify the series.
+ */
@JsonProperty("metric")
private Metric metric;
- /** Time series of metric values */
+ /** Each entry is one data point of the time series. */
@JsonProperty("values")
private Collection values;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MiniVectorIndex.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MiniVectorIndex.java
index 0b73f5c1e..2f50176cc 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MiniVectorIndex.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/MiniVectorIndex.java
@@ -7,6 +7,14 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * An AI Search index stores vectors and metadata on an endpoint and serves vector similarity,
+ * full-text and hybrid search queries over them. A Delta Sync index is kept in sync with a source
+ * table, with embeddings either computed by Databricks from a text column or supplied by you in a
+ * vector column; a Direct Vector Access index holds rows that you write through the upsert and
+ * delete data APIs. See https://docs.databricks.com/aws/en/ai-search/create-ai-search for how to
+ * choose between them.
+ */
@Generated
public class MiniVectorIndex {
/** The user who created the index. */
@@ -17,23 +25,29 @@ public class MiniVectorIndex {
@JsonProperty("endpoint_id")
private String endpointId;
- /** Name of the endpoint associated with the index */
+ /** Name of the endpoint that serves the index. */
@JsonProperty("endpoint_name")
private String endpointName;
- /** The subtype of the index. */
+ /**
+ * Subtype of the index. A `HYBRID` index supports vector similarity, full-text and hybrid
+ * queries; a `FULL_TEXT` index has no embeddings and supports only full-text queries.
+ */
@JsonProperty("index_subtype")
private IndexSubtype indexSubtype;
- /** */
+ /**
+ * Type of the index, which determines whether `delta_sync_index_spec` or
+ * `direct_access_index_spec` describes it.
+ */
@JsonProperty("index_type")
private VectorIndexType indexType;
- /** Name of the index */
+ /** Three-level Unity Catalog name of the index. */
@JsonProperty("name")
private String name;
- /** Primary key of the index */
+ /** Name of the column that uniquely identifies each row of the index. */
@JsonProperty("primary_key")
private String primaryKey;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexNextPageRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexNextPageRequest.java
index e2606c848..265f7b52f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexNextPageRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexNextPageRequest.java
@@ -11,7 +11,7 @@
/** Request payload for getting next page of results. */
@Generated
public class QueryVectorIndexNextPageRequest {
- /** Name of the endpoint. */
+ /** Name of the endpoint that serves the index. */
@JsonProperty("endpoint_name")
private String endpointName;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexRequest.java
index ebd154099..f8811a6f0 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/QueryVectorIndexRequest.java
@@ -11,7 +11,10 @@
@Generated
public class QueryVectorIndexRequest {
- /** List of column names to include in the response. */
+ /**
+ * Names of the columns to return for each result. At least one column is required, and only
+ * columns that are part of the index can be returned.
+ */
@JsonProperty("columns")
private Collection columns;
@@ -29,13 +32,12 @@ public class QueryVectorIndexRequest {
private Collection facets;
/**
- * JSON string representing query filters.
- *
- * Example filters:
- *
- *
- `{"id <": 5}`: Filter for id less than 5. - `{"id >": 5}`: Filter for id greater than 5. -
- * `{"id <=": 5}`: Filter for id less than equal to 5. - `{"id >=": 5}`: Filter for id greater
- * than equal to 5. - `{"id": 5}`: Filter for id equal to 5.
+ * Filters to apply to the results, as a JSON object serialized to a string. Each key is a column
+ * name, optionally followed by a space and an operator, and each value is the value or list of
+ * values to compare the column against. A key without an operator matches the value exactly, or
+ * any of the listed values. Supported operators are `NOT`, `<`, `<=`, `>`, `>=`, `OR` and `LIKE`;
+ * see https://docs.databricks.com/aws/en/ai-search/query-ai-search for their semantics. This
+ * field is not supported on storage-optimized endpoints.
*/
@JsonProperty("filters_json")
private String filtersJson;
@@ -43,7 +45,10 @@ public class QueryVectorIndexRequest {
/** Name of the vector index to query. */
@JsonIgnore private String indexName;
- /** Number of results to return. Defaults to 10. */
+ /**
+ * Maximum number of results to return. It must be greater than 0 and defaults to 10. By default,
+ * a `HYBRID` query can return at most 200 results.
+ */
@JsonProperty("num_results")
private Long numResults;
@@ -51,7 +56,11 @@ public class QueryVectorIndexRequest {
@JsonProperty("query_columns")
private Collection queryColumns;
- /** Query text. Required for Delta Sync Index using model endpoint. */
+ /**
+ * Text to search for. Use it for an index with Databricks-managed embeddings, which embeds the
+ * text with the index's embedding model endpoint, and for `FULL_TEXT` queries on any index. A
+ * `HYBRID` query on an index with managed embeddings requires only `query_text`.
+ */
@JsonProperty("query_text")
private String queryText;
@@ -60,8 +69,11 @@ public class QueryVectorIndexRequest {
private String queryType;
/**
- * Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed
- * vectors.
+ * Embedding vector to search for. Use it for an index whose embeddings you compute yourself: a
+ * Direct Vector Access index or a Delta Sync index with `embedding_vector_columns`. A `HYBRID`
+ * query on a Delta Sync index with `embedding_vector_columns`, or on a Direct Vector Access index
+ * without `embedding_source_columns`, requires both `query_vector` and `query_text`. A Direct
+ * Vector Access index with `embedding_source_columns` can be queried with `query_text` alone.
*/
@JsonProperty("query_vector")
private Collection queryVector;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RerankerConfigRerankerParameters.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RerankerConfigRerankerParameters.java
index cf8184596..b19ab8df6 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RerankerConfigRerankerParameters.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RerankerConfigRerankerParameters.java
@@ -10,7 +10,10 @@
@Generated
public class RerankerConfigRerankerParameters {
- /** */
+ /**
+ * Names of the columns whose values are sent to the reranker. List the most relevant column
+ * first, since the order affects the ranking.
+ */
@JsonProperty("columns_to_rerank")
private Collection columnsToRerank;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsRequest.java
index 4d7862b74..6b2b2df5f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsRequest.java
@@ -12,26 +12,34 @@
/** Request to retrieve user-visible metrics */
@Generated
public class RetrieveUserVisibleMetricsRequest {
- /** End time for metrics query */
+ /** End of the time range. Defaults to the current time. Must be later than `start_time`. */
@JsonProperty("end_time")
private String endTime;
- /** Granularity in seconds */
+ /**
+ * Requested interval between data points, in seconds. Defaults to 60, which is also the minimum.
+ * The server may return a finer or coarser interval: 60 seconds only for time ranges of 1 hour or
+ * less, otherwise 300 seconds or more. Read the interval from the returned timestamps.
+ */
@JsonProperty("granularity_in_seconds")
private Long granularityInSeconds;
- /** List of metrics to retrieve */
+ /**
+ * Metrics to retrieve. Each entry names a metric and optionally narrows it with labels or a
+ * percentile. An unknown metric name fails the whole request, and an empty list returns no
+ * series.
+ */
@JsonProperty("metrics")
private Collection metrics;
- /** AI Search endpoint name */
+ /** Name of the endpoint whose metrics to retrieve. */
@JsonIgnore private String name;
- /** Token for pagination */
+ /** Not used. The response returns all data points in one page. */
@JsonProperty("page_token")
private String pageToken;
- /** Start time for metrics query */
+ /** Start of the time range. Required. Must be within the last 169 hours. */
@JsonProperty("start_time")
private String startTime;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsResponse.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsResponse.java
index 4d3a69f6d..dfe687824 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsResponse.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/RetrieveUserVisibleMetricsResponse.java
@@ -11,14 +11,14 @@
/** Response containing user-visible metrics */
@Generated
public class RetrieveUserVisibleMetricsResponse {
- /** Collection of metric values */
+ /**
+ * One time series for each requested metric and each combination of label values it was broken
+ * down by.
+ */
@JsonProperty("metric_values")
private Collection metricValues;
- /**
- * A token that can be used to get the next page of results. If not present, there are no more
- * results to show.
- */
+ /** Not set. The response returns all data points in one page. */
@JsonProperty("next_page_token")
private String nextPageToken;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/UpsertDataVectorIndexRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/UpsertDataVectorIndexRequest.java
index e2bc68471..56da029e6 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/UpsertDataVectorIndexRequest.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/UpsertDataVectorIndexRequest.java
@@ -15,7 +15,11 @@ public class UpsertDataVectorIndexRequest {
*/
@JsonIgnore private String indexName;
- /** JSON string representing the data to be upserted. */
+ /**
+ * Rows to upsert, as a JSON array of objects serialized to a string. Each object maps column
+ * names from `schema_json` to values and must include the primary key. A row whose primary key
+ * already exists in the index is replaced.
+ */
@JsonProperty("inputs_json")
private String inputsJson;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndex.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndex.java
index 7ebcd6f09..43e1f37ff 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndex.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorIndex.java
@@ -7,17 +7,28 @@
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Objects;
+/**
+ * An AI Search index stores vectors and metadata on an endpoint and serves vector similarity,
+ * full-text and hybrid search queries over them. A Delta Sync index is kept in sync with a source
+ * table, with embeddings either computed by Databricks from a text column or supplied by you in a
+ * vector column; a Direct Vector Access index holds rows that you write through the upsert and
+ * delete data APIs. See https://docs.databricks.com/aws/en/ai-search/create-ai-search for how to
+ * choose between them.
+ */
@Generated
public class VectorIndex {
/** The user who created the index. */
@JsonProperty("creator")
private String creator;
- /** */
+ /** Specification of a Delta Sync index. Present only when `index_type` is `DELTA_SYNC`. */
@JsonProperty("delta_sync_index_spec")
private DeltaSyncVectorIndexSpecResponse deltaSyncIndexSpec;
- /** */
+ /**
+ * Specification of a Direct Vector Access index. Present only when `index_type` is
+ * `DIRECT_ACCESS`.
+ */
@JsonProperty("direct_access_index_spec")
private DirectAccessVectorIndexSpec directAccessIndexSpec;
@@ -25,27 +36,36 @@ public class VectorIndex {
@JsonProperty("endpoint_id")
private String endpointId;
- /** Name of the endpoint associated with the index */
+ /** Name of the endpoint that serves the index. */
@JsonProperty("endpoint_name")
private String endpointName;
- /** The subtype of the index. */
+ /**
+ * Subtype of the index. A `HYBRID` index supports vector similarity, full-text and hybrid
+ * queries; a `FULL_TEXT` index has no embeddings and supports only full-text queries.
+ */
@JsonProperty("index_subtype")
private IndexSubtype indexSubtype;
- /** */
+ /**
+ * Type of the index, which determines whether `delta_sync_index_spec` or
+ * `direct_access_index_spec` describes it.
+ */
@JsonProperty("index_type")
private VectorIndexType indexType;
- /** Name of the index */
+ /** Three-level Unity Catalog name of the index. */
@JsonProperty("name")
private String name;
- /** Primary key of the index */
+ /** Name of the column that uniquely identifies each row of the index. */
@JsonProperty("primary_key")
private String primaryKey;
- /** */
+ /**
+ * Current status of the index, including whether it is ready to serve queries and how many rows
+ * it holds.
+ */
@JsonProperty("status")
private VectorIndexStatus status;
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 ba6a90fee..57e4cae6b 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
@@ -25,7 +25,7 @@ public class VectorIndexStatus {
@JsonProperty("indexed_row_count")
private Long indexedRowCount;
- /** Message associated with the index status */
+ /** Human-readable description of the current status. */
@JsonProperty("message")
private String message;
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java
index 0ff454a80..9f5e3858f 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsAPI.java
@@ -154,7 +154,10 @@ public EndpointInfo patchEndpoint(PatchEndpointRequest request) {
return impl.patchEndpoint(request);
}
- /** Retrieve user-visible metrics for an endpoint */
+ /**
+ * Retrieve time series of usage and health metrics for an endpoint and its indexes, such as
+ * request counts, request latency percentiles and endpoint utilization.
+ */
public RetrieveUserVisibleMetricsResponse retrieveUserVisibleMetrics(
RetrieveUserVisibleMetricsRequest request) {
return impl.retrieveUserVisibleMetrics(request);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java
index 13cee06bf..91a6de444 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchEndpointsService.java
@@ -42,7 +42,10 @@ VectorSearchEndpointPermissions getPermissions(
*/
EndpointInfo patchEndpoint(PatchEndpointRequest patchEndpointRequest);
- /** Retrieve user-visible metrics for an endpoint */
+ /**
+ * Retrieve time series of usage and health metrics for an endpoint and its indexes, such as
+ * request counts, request latency percentiles and endpoint utilization.
+ */
RetrieveUserVisibleMetricsResponse retrieveUserVisibleMetrics(
RetrieveUserVisibleMetricsRequest retrieveUserVisibleMetricsRequest);
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesAPI.java
index 4b33adc17..cb5cf66f2 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesAPI.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesAPI.java
@@ -33,7 +33,11 @@ public VectorSearchIndexesAPI(VectorSearchIndexesService mock) {
impl = mock;
}
- /** Create a new index. */
+ /**
+ * Create a new index on an endpoint. Creating a Delta Sync index also creates the pipeline that
+ * populates it from the source table; a Direct Vector Access index starts empty and is populated
+ * through Upsert data into an index.
+ */
public VectorIndex createIndex(CreateVectorIndexRequest request) {
return impl.createIndex(request);
}
@@ -42,7 +46,10 @@ public DeleteDataVectorIndexResponse deleteDataVectorIndex(String indexName) {
return deleteDataVectorIndex(new DeleteDataVectorIndexRequest().setIndexName(indexName));
}
- /** Handles the deletion of data from a specified vector index. */
+ /**
+ * Delete rows from a Direct Vector Access index by primary key. The response reports how many
+ * rows were deleted and the primary keys of the rows that failed.
+ */
public DeleteDataVectorIndexResponse deleteDataVectorIndex(DeleteDataVectorIndexRequest request) {
return impl.deleteDataVectorIndex(request);
}
@@ -51,7 +58,9 @@ public void deleteIndex(String indexName) {
deleteIndex(new DeleteIndexRequest().setIndexName(indexName));
}
- /** Delete an index. */
+ /**
+ * Delete an index and the data it holds. The source table of a Delta Sync index is not affected.
+ */
public void deleteIndex(DeleteIndexRequest request) {
impl.deleteIndex(request);
}
@@ -84,7 +93,10 @@ public Iterable listIndexes(ListIndexesRequest request) {
});
}
- /** Query the specified vector index. */
+ /**
+ * Query an index with a vector, text, or both, and return the requested columns of the
+ * best-matching rows.
+ */
public QueryVectorIndexResponse queryIndex(QueryVectorIndexRequest request) {
return impl.queryIndex(request);
}
@@ -98,19 +110,26 @@ public QueryVectorIndexResponse queryNextPage(QueryVectorIndexNextPageRequest re
}
/**
- * Scan the specified vector index and return the first `num_results` entries after the exclusive
- * `primary_key`.
+ * Scan an index and return the first `num_results` rows after the exclusive `last_primary_key`.
+ * Repeat the call with the returned `last_primary_key` to read the whole index.
*/
public ScanVectorIndexResponse scanIndex(ScanVectorIndexRequest request) {
return impl.scanIndex(request);
}
- /** Triggers a synchronization process for a specified vector index. */
+ /**
+ * Start a sync of a Delta Sync index with a `TRIGGERED` pipeline from its source table. An index
+ * with a `CONTINUOUS` pipeline syncs automatically and rejects manual syncs.
+ */
public void syncIndex(SyncIndexRequest request) {
impl.syncIndex(request);
}
- /** Handles the upserting of data into a specified vector index. */
+ /**
+ * Insert rows into a Direct Vector Access index, replacing existing rows that have the same
+ * primary key. The response reports how many rows succeeded and the primary keys of the rows that
+ * failed.
+ */
public UpsertDataVectorIndexResponse upsertDataVectorIndex(UpsertDataVectorIndexRequest request) {
return impl.upsertDataVectorIndex(request);
}
diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesService.java
index c54853c52..e9a0e55d3 100644
--- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesService.java
+++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/vectorsearch/VectorSearchIndexesService.java
@@ -19,14 +19,23 @@
*/
@Generated
public interface VectorSearchIndexesService {
- /** Create a new index. */
+ /**
+ * Create a new index on an endpoint. Creating a Delta Sync index also creates the pipeline that
+ * populates it from the source table; a Direct Vector Access index starts empty and is populated
+ * through Upsert data into an index.
+ */
VectorIndex createIndex(CreateVectorIndexRequest createVectorIndexRequest);
- /** Handles the deletion of data from a specified vector index. */
+ /**
+ * Delete rows from a Direct Vector Access index by primary key. The response reports how many
+ * rows were deleted and the primary keys of the rows that failed.
+ */
DeleteDataVectorIndexResponse deleteDataVectorIndex(
DeleteDataVectorIndexRequest deleteDataVectorIndexRequest);
- /** Delete an index. */
+ /**
+ * Delete an index and the data it holds. The source table of a Delta Sync index is not affected.
+ */
void deleteIndex(DeleteIndexRequest deleteIndexRequest);
/** Get an index. */
@@ -35,7 +44,10 @@ DeleteDataVectorIndexResponse deleteDataVectorIndex(
/** List all indexes in the given endpoint. */
ListVectorIndexesResponse listIndexes(ListIndexesRequest listIndexesRequest);
- /** Query the specified vector index. */
+ /**
+ * Query an index with a vector, text, or both, and return the requested columns of the
+ * best-matching rows.
+ */
QueryVectorIndexResponse queryIndex(QueryVectorIndexRequest queryVectorIndexRequest);
/**
@@ -46,15 +58,22 @@ QueryVectorIndexResponse queryNextPage(
QueryVectorIndexNextPageRequest queryVectorIndexNextPageRequest);
/**
- * Scan the specified vector index and return the first `num_results` entries after the exclusive
- * `primary_key`.
+ * Scan an index and return the first `num_results` rows after the exclusive `last_primary_key`.
+ * Repeat the call with the returned `last_primary_key` to read the whole index.
*/
ScanVectorIndexResponse scanIndex(ScanVectorIndexRequest scanVectorIndexRequest);
- /** Triggers a synchronization process for a specified vector index. */
+ /**
+ * Start a sync of a Delta Sync index with a `TRIGGERED` pipeline from its source table. An index
+ * with a `CONTINUOUS` pipeline syncs automatically and rejects manual syncs.
+ */
void syncIndex(SyncIndexRequest syncIndexRequest);
- /** Handles the upserting of data into a specified vector index. */
+ /**
+ * Insert rows into a Direct Vector Access index, replacing existing rows that have the same
+ * primary key. The response reports how many rows succeeded and the primary keys of the rows that
+ * failed.
+ */
UpsertDataVectorIndexResponse upsertDataVectorIndex(
UpsertDataVectorIndexRequest upsertDataVectorIndexRequest);
}
diff --git a/examples/docs/pom.xml b/examples/docs/pom.xml
index 6800dffda..879af0e90 100644
--- a/examples/docs/pom.xml
+++ b/examples/docs/pom.xml
@@ -24,7 +24,7 @@
com.databricks
databricks-sdk-java
- 0.182.0
+ 0.183.0
diff --git a/examples/spring-boot-oauth-u2m-demo/pom.xml b/examples/spring-boot-oauth-u2m-demo/pom.xml
index 0a26a42d6..64de34367 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.182.0
+ 0.183.0
diff --git a/lockfile.json b/lockfile.json
index eac264926..c8e84a4e0 100644
--- a/lockfile.json
+++ b/lockfile.json
@@ -1,7 +1,7 @@
{
"artifactId": "databricks-sdk-parent",
"groupId": "com.databricks",
- "version": "0.182.0",
+ "version": "0.183.0",
"lockFileVersion": 1,
"dependencies": [],
"mavenPlugins": [],
diff --git a/pom.xml b/pom.xml
index bc5396ead..f48cb819a 100644
--- a/pom.xml
+++ b/pom.xml
@@ -4,7 +4,7 @@
4.0.0
com.databricks
databricks-sdk-parent
- 0.182.0
+ 0.183.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 b6dab447d..a2780353d 100644
--- a/shaded/pom.xml
+++ b/shaded/pom.xml
@@ -4,7 +4,7 @@
4.0.0
- 0.182.0
+ 0.183.0
com.databricks