com.databricks.sdk.service.provisioning

Class PrivateAccessAPI

java.lang.Object

com.databricks.sdk.service.provisioning.PrivateAccessAPI

@Generated
public class PrivateAccessAPI
extends Object

These APIs manage private access settings for this account.

Constructor Summary

Constructors

Constructor and Description
PrivateAccessAPI(ApiClient apiClient) Regular-use constructor
PrivateAccessAPI(PrivateAccessService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
PrivateAccessSettings	create(CreatePrivateAccessSettingsRequest request) Creates a private access settings configuration, which represents network access restrictions for workspace resources.
PrivateAccessSettings	delete(DeletePrivateAccesRequest request) Deletes a Databricks private access settings configuration, both specified by ID.
PrivateAccessSettings	delete(String privateAccessSettingsId)
PrivateAccessSettings	get(GetPrivateAccesRequest request) Gets a Databricks private access settings configuration, both specified by ID.
PrivateAccessSettings	get(String privateAccessSettingsId)
PrivateAccessService	impl()
Iterable<PrivateAccessSettings>	list() Lists Databricks private access settings for an account.
PrivateAccessSettings	replace(ReplacePrivateAccessSettingsRequest request) Updates an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLink.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivateAccessAPI

public PrivateAccessAPI(ApiClient apiClient)

Regular-use constructor

PrivateAccessAPI

public PrivateAccessAPI(PrivateAccessService mock)

Constructor for mocks

Method Detail

create

public PrivateAccessSettings create(CreatePrivateAccessSettingsRequest request)

Creates a private access settings configuration, which represents network access restrictions for workspace resources. Private access settings configure whether workspaces can be accessed from the public internet or only from private endpoints.

delete

public PrivateAccessSettings delete(String privateAccessSettingsId)

delete

public PrivateAccessSettings delete(DeletePrivateAccesRequest request)

Deletes a Databricks private access settings configuration, both specified by ID.

get

public PrivateAccessSettings get(String privateAccessSettingsId)

get

public PrivateAccessSettings get(GetPrivateAccesRequest request)

Gets a Databricks private access settings configuration, both specified by ID.

list

public Iterable<PrivateAccessSettings> list()

Lists Databricks private access settings for an account.

replace

public PrivateAccessSettings replace(ReplacePrivateAccessSettingsRequest request)

Updates an existing private access settings object, which specifies how your workspace is accessed over AWS PrivateLink. To use AWS PrivateLink, a workspace must have a private access settings object referenced by ID in the workspace's private_access_settings_id property. This operation completely overwrites your existing private access settings object attached to your workspaces. All workspaces attached to the private access settings are affected by any change. If public_access_enabled, private_access_level, or allowed_vpc_endpoint_ids are updated, effects of these changes might take several minutes to propagate to the workspace API. You can share one private access settings object with multiple workspaces in a single account. However, private access settings are specific to AWS regions, so only workspaces in the same AWS region can use a given private access settings object. Before configuring PrivateLink, read the Databricks article about PrivateLink.

impl

public PrivateAccessService impl()