@Generated public interface BundleService
This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.
| Modifier and Type | Method and Description |
|---|---|
Version |
completeVersion(CompleteVersionRequest completeVersionRequest)
Marks a version as complete and releases the deployment lock.
|
Deployment |
createDeployment(CreateDeploymentRequest createDeploymentRequest)
Creates a new deployment in the workspace.
|
Operation |
createOperation(CreateOperationRequest createOperationRequest)
Creates a resource operation under a version.
|
Version |
createVersion(CreateVersionRequest createVersionRequest)
Creates a new version under a deployment.
|
void |
deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
Deletes a deployment.
|
Deployment |
getDeployment(GetDeploymentRequest getDeploymentRequest)
Retrieves a deployment by its resource name.
|
Operation |
getOperation(GetOperationRequest getOperationRequest)
Retrieves a resource operation by its resource name.
|
Resource |
getResource(GetResourceRequest getResourceRequest)
Retrieves a deployment resource by its resource name.
|
Version |
getVersion(GetVersionRequest getVersionRequest)
Retrieves a version by its resource name.
|
HeartbeatResponse |
heartbeat(HeartbeatRequest heartbeatRequest)
Sends a heartbeat to renew the lock held by a version.
|
ListDeploymentsResponse |
listDeployments(ListDeploymentsRequest listDeploymentsRequest)
Lists deployments in the workspace.
|
ListOperationsResponse |
listOperations(ListOperationsRequest listOperationsRequest)
Lists resource operations under a version.
|
ListResourcesResponse |
listResources(ListResourcesRequest listResourcesRequest)
Lists resources under a deployment.
|
ListVersionsResponse |
listVersions(ListVersionsRequest listVersionsRequest)
Lists versions under a deployment, ordered by version_id descending (most recent first).
|
Version completeVersion(CompleteVersionRequest completeVersionRequest)
The server atomically: 1. Sets the version status to the provided terminal status. 2. Sets `complete_time` to the current server timestamp. 3. Releases the lock on the parent deployment. 4. Updates the parent deployment's `status` and `last_version_id`.
Deployment createDeployment(CreateDeploymentRequest createDeploymentRequest)
The caller must provide a `deployment_id` which becomes the final component of the deployment's resource name. If a deployment with the same ID already exists, the server returns `ALREADY_EXISTS`.
Operation createOperation(CreateOperationRequest createOperationRequest)
The caller must provide a `resource_key` which becomes the final component of the operation's name. If an operation with the same key already exists under the version, the server returns `ALREADY_EXISTS`.
On success the server also updates the corresponding deployment-level Resource (creating it if this is the first operation for that resource_key, or removing it if action_type is DELETE).
Version createVersion(CreateVersionRequest createVersionRequest)
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.
void deleteDeployment(DeleteDeploymentRequest deleteDeploymentRequest)
The deployment is marked as deleted. It and all its children (versions and their operations) will be permanently deleted after the retention policy expires. If the deployment has an in-progress version, the server returns `RESOURCE_CONFLICT`.
Deployment getDeployment(GetDeploymentRequest getDeploymentRequest)
Operation getOperation(GetOperationRequest getOperationRequest)
Resource getResource(GetResourceRequest getResourceRequest)
Version getVersion(GetVersionRequest getVersionRequest)
HeartbeatResponse heartbeat(HeartbeatRequest heartbeatRequest)
The server validates that the version is the active (non-terminal) version on the parent deployment and resets the lock expiry. If the lock has already expired or the version is no longer active, the server returns `ABORTED`.
ListDeploymentsResponse listDeployments(ListDeploymentsRequest listDeploymentsRequest)
ListOperationsResponse listOperations(ListOperationsRequest listOperationsRequest)
ListResourcesResponse listResources(ListResourcesRequest listResourcesRequest)
ListVersionsResponse listVersions(ListVersionsRequest listVersionsRequest)
Copyright © 2026. All rights reserved.