com.databricks.sdk.service.compute

Class ClusterPoliciesAPI

java.lang.Object

com.databricks.sdk.service.compute.ClusterPoliciesAPI

@Generated
public class ClusterPoliciesAPI
extends Object

You can use cluster policies to control users' ability to configure clusters based on a set of rules. These rules specify which attributes or attribute values can be used during cluster creation. Cluster policies have ACLs that limit their use to specific users and groups.

With cluster policies, you can: - Auto-install cluster libraries on the next restart by listing them in the policy's "libraries" field. - Limit users to creating clusters with the prescribed settings. - Simplify the user interface, enabling more users to create clusters, by fixing and hiding some fields. - Manage costs by setting limits on attributes that impact the hourly rate.

Cluster policy permissions limit which policies a user can select in the Policy drop-down when the user creates a cluster: - A user who has unrestricted cluster create permission can select the Unrestricted policy and create fully-configurable clusters. - A user who has both unrestricted cluster create permission and access to cluster policies can select the Unrestricted policy and policies they have access to. - A user that has access to only cluster policies, can select the policies they have access to.

If no policies exist in the workspace, the Policy drop-down doesn't appear. Only admin users can create, edit, and delete policies. Admin users also have access to all policies.

Constructor Summary

Constructors

Constructor and Description
ClusterPoliciesAPI(ApiClient apiClient) Regular-use constructor
ClusterPoliciesAPI(ClusterPoliciesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CreatePolicyResponse	create(CreatePolicy request) Create a new policy.
CreatePolicyResponse	create(String name)
void	delete(DeletePolicy request) Delete a cluster policy.
void	delete(String policyId)
void	edit(EditPolicy request) Update a cluster policy.
void	edit(String policyId, String name)
Policy	get(GetClusterPolicyRequest request) Get a cluster policy.
Policy	get(String policyId)
GetClusterPolicyPermissionLevelsResponse	getPermissionLevels(GetClusterPolicyPermissionLevelsRequest request) Get cluster policy permission levels.
GetClusterPolicyPermissionLevelsResponse	getPermissionLevels(String clusterPolicyId)
ClusterPolicyPermissions	getPermissions(GetClusterPolicyPermissionsRequest request) Get cluster policy permissions.
ClusterPolicyPermissions	getPermissions(String clusterPolicyId)
ClusterPoliciesService	impl()
Iterable<Policy>	list(ListClusterPoliciesRequest request) List cluster policies.
ClusterPolicyPermissions	setPermissions(ClusterPolicyPermissionsRequest request) Set cluster policy permissions.
ClusterPolicyPermissions	setPermissions(String clusterPolicyId)
ClusterPolicyPermissions	updatePermissions(ClusterPolicyPermissionsRequest request) Update cluster policy permissions.
ClusterPolicyPermissions	updatePermissions(String clusterPolicyId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClusterPoliciesAPI

public ClusterPoliciesAPI(ApiClient apiClient)

Regular-use constructor

ClusterPoliciesAPI

public ClusterPoliciesAPI(ClusterPoliciesService mock)

Constructor for mocks

Method Detail

create

public CreatePolicyResponse create(String name)

create

public CreatePolicyResponse create(CreatePolicy request)

Create a new policy.

Creates a new policy with prescribed settings.

delete

public void delete(String policyId)

delete

public void delete(DeletePolicy request)

Delete a cluster policy.

Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.

edit

public void edit(String policyId,
                 String name)

edit

public void edit(EditPolicy request)

Update a cluster policy.

Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid.

get

public Policy get(String policyId)

get

public Policy get(GetClusterPolicyRequest request)

Get a cluster policy.

Get a cluster policy entity. Creation and editing is available to admins only.

getPermissionLevels

public GetClusterPolicyPermissionLevelsResponse getPermissionLevels(String clusterPolicyId)

getPermissionLevels

public GetClusterPolicyPermissionLevelsResponse getPermissionLevels(GetClusterPolicyPermissionLevelsRequest request)

Get cluster policy permission levels.

Gets the permission levels that a user can have on an object.

getPermissions

public ClusterPolicyPermissions getPermissions(String clusterPolicyId)

getPermissions

public ClusterPolicyPermissions getPermissions(GetClusterPolicyPermissionsRequest request)

Get cluster policy permissions.

Gets the permissions of a cluster policy. Cluster policies can inherit permissions from their root object.

list

public Iterable<Policy> list(ListClusterPoliciesRequest request)

List cluster policies.

Returns a list of policies accessible by the requesting user.

setPermissions

public ClusterPolicyPermissions setPermissions(String clusterPolicyId)

setPermissions

public ClusterPolicyPermissions setPermissions(ClusterPolicyPermissionsRequest request)

Set cluster policy permissions.

Sets permissions on a cluster policy. Cluster policies can inherit permissions from their root object.

updatePermissions

public ClusterPolicyPermissions updatePermissions(String clusterPolicyId)

updatePermissions

public ClusterPolicyPermissions updatePermissions(ClusterPolicyPermissionsRequest request)

Update cluster policy permissions.

Updates the permissions on a cluster policy. Cluster policies can inherit permissions from their root object.

impl

public ClusterPoliciesService impl()