Package com.databricks.sdk.service.provisioning

Class StorageAPI

java.lang.Object

com.databricks.sdk.service.provisioning.StorageAPI

@Generated
public class StorageAPI
extends Object

These APIs manage storage configurations for this workspace. A root storage S3 bucket in your account is required to store objects like cluster logs, notebook revisions, and job results. You can also use the root storage S3 bucket for storage of non-production DBFS data. A storage configuration encapsulates this bucket information, and its ID is used when creating a new workspace.

Constructor Summary

Constructors

Constructor	Description
StorageAPI(ApiClient apiClient)	Regular-use constructor
StorageAPI(StorageService mock)	Constructor for mocks

Method Summary

Modifier and Type	Method	Description
StorageConfiguration	create(CreateStorageConfigurationRequest request)	Create new storage configuration.
StorageConfiguration	create(String storageConfigurationName, RootBucketInfo rootBucketInfo)
void	delete(DeleteStorageRequest request)	Delete storage configuration.
void	delete(String storageConfigurationId)
StorageConfiguration	get(GetStorageRequest request)	Get storage configuration.
StorageConfiguration	get(String storageConfigurationId)
StorageService	impl()
Iterable<StorageConfiguration>	list()	Get all storage configurations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageAPI

public StorageAPI(ApiClient apiClient)

Regular-use constructor

StorageAPI

public StorageAPI(StorageService mock)

Constructor for mocks

Method Detail

create

public StorageConfiguration create(String storageConfigurationName,
                                   RootBucketInfo rootBucketInfo)

create

public StorageConfiguration create(CreateStorageConfigurationRequest request)

Create new storage configuration.

Creates new storage configuration for an account, specified by ID. Uploads a storage configuration object that represents the root AWS S3 bucket in your account. Databricks stores related workspace assets including DBFS, cluster logs, and job results. For the AWS S3 bucket, you need to configure the required bucket policy.

For information about how to create a new workspace with this API, see [Create a new workspace using the Account API]

[Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html

delete

public void delete(String storageConfigurationId)

delete

public void delete(DeleteStorageRequest request)

Delete storage configuration.

Deletes a Databricks storage configuration. You cannot delete a storage configuration that is associated with any workspace.

get

public StorageConfiguration get(String storageConfigurationId)

get

public StorageConfiguration get(GetStorageRequest request)

Get storage configuration.

Gets a Databricks storage configuration for an account, both specified by ID.

list

public Iterable<StorageConfiguration> list()

Get all storage configurations.

Gets a list of all Databricks storage configurations for your account, specified by ID.

impl

public StorageService impl()