BundleAPI (Databricks SDK for Java 0.112.0 API)

java.lang.Object
- com.databricks.sdk.service.bundle.BundleAPI

@Generated
public class BundleAPI
extends Object

Service for managing bundle deployment metadata.

Constructor Summary

Constructors
Constructor and Description

BundleAPI(ApiClient apiClient)
Regular-use constructor

BundleAPI(BundleService mock)
Constructor for mocks

Constructors
Constructor and Description
`BundleAPI(ApiClient apiClient)` Regular-use constructor
`BundleAPI(BundleService mock)` Constructor for mocks

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Version`	`completeVersion(CompleteVersionRequest request)` Marks a version as complete and releases the deployment lock.
`Deployment`	`createDeployment(CreateDeploymentRequest request)` Creates a new deployment in the workspace.
`Operation`	`createOperation(CreateOperationRequest request)` Creates a resource operation under a version.
`Version`	`createVersion(CreateVersionRequest request)` Creates a new version under a deployment.
`void`	`deleteDeployment(DeleteDeploymentRequest request)` Deletes a deployment.
`void`	`deleteDeployment(String name)`
`Deployment`	`getDeployment(GetDeploymentRequest request)` Retrieves a deployment by its resource name.
`Deployment`	`getDeployment(String name)`
`Operation`	`getOperation(GetOperationRequest request)` Retrieves a resource operation by its resource name.
`Operation`	`getOperation(String name)`
`Resource`	`getResource(GetResourceRequest request)` Retrieves a deployment resource by its resource name.
`Resource`	`getResource(String name)`
`Version`	`getVersion(GetVersionRequest request)` Retrieves a version by its resource name.
`Version`	`getVersion(String name)`
`HeartbeatResponse`	`heartbeat(HeartbeatRequest request)` Sends a heartbeat to renew the lock held by a version.
`BundleService`	`impl()`
`Iterable<Deployment>`	`listDeployments(ListDeploymentsRequest request)` Lists deployments in the workspace.
`Iterable<Operation>`	`listOperations(ListOperationsRequest request)` Lists resource operations under a version.
`Iterable<Operation>`	`listOperations(String parent)`
`Iterable<Resource>`	`listResources(ListResourcesRequest request)` Lists resources under a deployment.
`Iterable<Resource>`	`listResources(String parent)`
`Iterable<Version>`	`listVersions(ListVersionsRequest request)` Lists versions under a deployment, ordered by version_id descending (most recent first).
`Iterable<Version>`	`listVersions(String parent)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BundleAPI
```
public BundleAPI(ApiClient apiClient)
```
    Regular-use constructor
  - BundleAPI
```
public BundleAPI(BundleService mock)
```
    Constructor for mocks
- Method Detail
  - completeVersion
```
public Version completeVersion(CompleteVersionRequest request)
```
    Marks a version as complete and releases the deployment lock.
    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`.
  - createDeployment
```
public Deployment createDeployment(CreateDeploymentRequest request)
```
    Creates a new deployment in the workspace.
    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`.
  - createOperation
```
public Operation createOperation(CreateOperationRequest request)
```
    Creates a resource operation under a version.
    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).
  - createVersion
```
public Version createVersion(CreateVersionRequest 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.
  - deleteDeployment
```
public void deleteDeployment(String name)
```
  - deleteDeployment
```
public void deleteDeployment(DeleteDeploymentRequest request)
```
    Deletes a deployment.
    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`.
  - getDeployment
```
public Deployment getDeployment(String name)
```
  - getDeployment
```
public Deployment getDeployment(GetDeploymentRequest request)
```
    Retrieves a deployment by its resource name.
  - getOperation
```
public Operation getOperation(String name)
```
  - getOperation
```
public Operation getOperation(GetOperationRequest request)
```
    Retrieves a resource operation by its resource name.
  - getResource
```
public Resource getResource(String name)
```
  - getResource
```
public Resource getResource(GetResourceRequest request)
```
    Retrieves a deployment resource by its resource name.
  - getVersion
```
public Version getVersion(String name)
```
  - getVersion
```
public Version getVersion(GetVersionRequest request)
```
    Retrieves a version by its resource name.
  - heartbeat
```
public HeartbeatResponse heartbeat(HeartbeatRequest request)
```
    Sends a heartbeat to renew the lock held by a version.
    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`.
  - listDeployments
```
public Iterable<Deployment> listDeployments(ListDeploymentsRequest request)
```
    Lists deployments in the workspace.
  - listOperations
```
public Iterable<Operation> listOperations(String parent)
```
  - listOperations
```
public Iterable<Operation> listOperations(ListOperationsRequest request)
```
    Lists resource operations under a version.
  - listResources
```
public Iterable<Resource> listResources(String parent)
```
  - listResources
```
public Iterable<Resource> listResources(ListResourcesRequest request)
```
    Lists resources under a deployment.
  - listVersions
```
public Iterable<Version> listVersions(String parent)
```
  - listVersions
```
public Iterable<Version> listVersions(ListVersionsRequest request)
```
    Lists versions under a deployment, ordered by version_id descending (most recent first).
  - impl
```
public BundleService impl()
```

Class BundleAPI

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BundleAPI

BundleAPI

Method Detail

completeVersion

createDeployment

createOperation

createVersion

deleteDeployment

deleteDeployment

getDeployment

getDeployment

getOperation

getOperation

getResource

getResource

getVersion

getVersion

heartbeat

listDeployments

listOperations

listOperations

listResources

listResources

listVersions

listVersions

impl