com.databricks.sdk.service.compute

Interface ClusterPoliciesService

@Generated
public interface ClusterPoliciesService

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 (Public Preview). - 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.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
CreatePolicyResponse	create(CreatePolicy createPolicy) Creates a new policy with prescribed settings.
void	delete(DeletePolicy deletePolicy) Delete a policy for a cluster.
void	edit(EditPolicy editPolicy) Update an existing policy for cluster.
Policy	get(GetClusterPolicyRequest getClusterPolicyRequest) Get a cluster policy entity.
GetClusterPolicyPermissionLevelsResponse	getPermissionLevels(GetClusterPolicyPermissionLevelsRequest getClusterPolicyPermissionLevelsRequest) Gets the permission levels that a user can have on an object.
ClusterPolicyPermissions	getPermissions(GetClusterPolicyPermissionsRequest getClusterPolicyPermissionsRequest) Gets the permissions of a cluster policy.
ListPoliciesResponse	list(ListClusterPoliciesRequest listClusterPoliciesRequest) Returns a list of policies accessible by the requesting user.
ClusterPolicyPermissions	setPermissions(ClusterPolicyPermissionsRequest clusterPolicyPermissionsRequest) Sets permissions on an object, replacing existing permissions if they exist.
ClusterPolicyPermissions	updatePermissions(ClusterPolicyPermissionsRequest clusterPolicyPermissionsRequest) Updates the permissions on a cluster policy.

Method Detail

create

CreatePolicyResponse create(CreatePolicy createPolicy)

Creates a new policy with prescribed settings.

delete

void delete(DeletePolicy deletePolicy)

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

edit

void edit(EditPolicy editPolicy)

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

get

Policy get(GetClusterPolicyRequest getClusterPolicyRequest)

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

getPermissionLevels

GetClusterPolicyPermissionLevelsResponse getPermissionLevels(GetClusterPolicyPermissionLevelsRequest getClusterPolicyPermissionLevelsRequest)

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

getPermissions

ClusterPolicyPermissions getPermissions(GetClusterPolicyPermissionsRequest getClusterPolicyPermissionsRequest)

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

list

ListPoliciesResponse list(ListClusterPoliciesRequest listClusterPoliciesRequest)

Returns a list of policies accessible by the requesting user.

setPermissions

ClusterPolicyPermissions setPermissions(ClusterPolicyPermissionsRequest clusterPolicyPermissionsRequest)

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their root object.

updatePermissions

ClusterPolicyPermissions updatePermissions(ClusterPolicyPermissionsRequest clusterPolicyPermissionsRequest)

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