diff --git a/.codegen/_openapi_sha b/.codegen/_openapi_sha index 4da5ee019..e68a3ddf5 100755 --- a/.codegen/_openapi_sha +++ b/.codegen/_openapi_sha @@ -1 +1 @@ -666a25255b50c87fe6fb8a2e573c92c841b048fd \ No newline at end of file +951ffbf1551ea1d4347a91e1b3955298605c7526 \ No newline at end of file diff --git a/NEXT_CHANGELOG.md b/NEXT_CHANGELOG.md index 073ed4bfd..c7b2dc1c9 100755 --- a/NEXT_CHANGELOG.md +++ b/NEXT_CHANGELOG.md @@ -17,4 +17,4 @@ ### Internal Changes ### API Changes -* Add `XLARGE` enum value for `com.databricks.sdk.service.apps.ComputeSize`. \ No newline at end of file +* Add `XLARGE` enum value for `com.databricks.sdk.service.apps.ComputeSize`. diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsAPI.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsAPI.java index 6a1d197a7..26b4c7a68 100755 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsAPI.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsAPI.java @@ -64,8 +64,10 @@ public Operation createOperation(CreateOperationRequest request) { * Creates a new version under a deployment. * *

Creating a version acquires an exclusive lock on the deployment, preventing concurrent - * deploys. The caller provides a `version_id` which the server validates equals `last_version_id - * + 1` on the deployment. + * deploys. The caller provides a `version_id`, a numeric string that must be numerically greater + * than the deployment's most recent version, and sets the version's `previous_version_id` to the + * deployment's most recent version (leaving it unset for the first version), which the server + * validates to detect concurrent deploys. */ public Version createVersion(CreateVersionRequest request) { return impl.createVersion(request); @@ -190,7 +192,10 @@ public Iterable listVersions(String parent) { return listVersions(new ListVersionsRequest().setParent(parent)); } - /** Lists versions under a deployment, ordered by version_id descending (most recent first). */ + /** + * Lists versions under a deployment, ordered numerically by version_id descending (most recent + * first). + */ public Iterable listVersions(ListVersionsRequest request) { return Paginator.newTokenPagination( request, diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java index 9ac15e87a..39912b3e0 100755 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/BundleDeploymentsService.java @@ -46,8 +46,10 @@ public interface BundleDeploymentsService { * Creates a new version under a deployment. * *

Creating a version acquires an exclusive lock on the deployment, preventing concurrent - * deploys. The caller provides a `version_id` which the server validates equals `last_version_id - * + 1` on the deployment. + * deploys. The caller provides a `version_id`, a numeric string that must be numerically greater + * than the deployment's most recent version, and sets the version's `previous_version_id` to the + * deployment's most recent version (leaving it unset for the first version), which the server + * validates to detect concurrent deploys. */ Version createVersion(CreateVersionRequest createVersionRequest); @@ -90,6 +92,9 @@ public interface BundleDeploymentsService { /** Lists resources under a deployment. */ ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest); - /** Lists versions under a deployment, ordered by version_id descending (most recent first). */ + /** + * Lists versions under a deployment, ordered numerically by version_id descending (most recent + * first). + */ ListVersionsResponse listVersions(ListVersionsRequest listVersionsRequest); } diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java index 64a4a00bc..85623772d 100755 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/CreateVersionRequest.java @@ -21,8 +21,12 @@ public class CreateVersionRequest { private Version version; /** - * The version ID the caller expects to create. The server validates this equals `last_version_id - * + 1` on the deployment. If it doesn't match, the server returns `ABORTED`. + * The ID to use for the version, which becomes the final component of the version's resource + * name. A numeric string (base-10, fits in a signed 64-bit integer) chosen by the caller; must be + * greater than or equal to 1. Must be numerically greater than the deployment's most recent + * version (see `version.previous_version_id`); it does not need to start at 1 or increase by + * exactly 1. If the value is not numerically greater, the server returns + * `INVALID_PARAMETER_VALUE`. */ @JsonIgnore @QueryParam("version_id") diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Operation.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Operation.java index db53f09c4..c8eba6564 100755 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Operation.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Operation.java @@ -10,8 +10,10 @@ import java.util.Objects; /** - * An operation on a single resource performed during a version. Operations are append-only and - * record the result of applying a resource change to the workspace. + * An operation on a single resource performed during a version. Operations record the result of + * applying a resource change to the workspace. Most fields are immutable once recorded; `state`, + * `error_message`, `resource_id`, and `status` may be updated afterwards (via UpdateOperation), + * guarded by `sequence_id` for optimistic concurrency control. */ @Generated public class Operation { @@ -25,7 +27,9 @@ public class Operation { /** * Error message if the operation failed. Set when status is OPERATION_STATUS_FAILED. Captures the - * error encountered while applying the resource to the workspace. + * error encountered while applying the resource to the workspace. Mutable: may be updated after + * creation via UpdateOperation; setting it to an empty string clears it. After an update is + * applied, an operation whose status is OPERATION_STATUS_SUCCEEDED cannot carry an error_message. */ @JsonProperty("error_message") private String errorMessage; @@ -38,9 +42,10 @@ public class Operation { private String name; /** - * ID of the actual resource in the workspace (e.g. the job ID, pipeline ID). Required for every - * operation except CREATE and RECREATE, which produce a new resource whose ID is not yet known - * when the operation is recorded. + * ID of the actual resource in the workspace (e.g. the job ID, pipeline ID). Optional at + * creation: CREATE and RECREATE operations produce a new resource whose ID is not yet known when + * the operation is recorded. Mutable: may be filled in (or corrected) later via UpdateOperation + * once the ID is known. */ @JsonProperty("resource_id") private String resourceId; @@ -60,11 +65,19 @@ public class Operation { @JsonProperty("resource_type") private DeploymentResourceType resourceType; - /** Serialized local config state after the operation. Should be unset for delete operations. */ + /** + * Serialized local config state after the operation. Should be unset for delete operations. + * Mutable: may be updated after creation via UpdateOperation. When updating, the caller must echo + * the last-observed `sequence_id` as a concurrency precondition. + */ @JsonProperty("state") private JsonNode state; - /** Whether the operation succeeded or failed. */ + /** + * Whether the operation succeeded or failed. Mutable: may be updated after creation via + * UpdateOperation, e.g. when an operation recorded as failed is retried and eventually succeeds. + * A succeeded operation cannot carry an `error_message`. + */ @JsonProperty("status") private OperationStatus status; diff --git a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Version.java b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Version.java index 0a1f86f9e..0d9a70d3b 100755 --- a/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Version.java +++ b/databricks-sdk-java/src/main/java/com/databricks/sdk/service/bundledeployments/Version.java @@ -72,8 +72,10 @@ public class Version { private String targetName; /** - * Monotonically increasing version identifier within the parent deployment. Assigned by the - * client on creation. + * Version identifier within the parent deployment, assigned by the client on creation. A numeric + * string (base-10, fits in a signed 64-bit integer) that is greater than or equal to 1. Version + * IDs are strictly increasing within a deployment but are not required to start at 1 or to be + * contiguous. */ @JsonProperty("version_id") private String versionId;