com.databricks.sdk.service.compute.ClusterPoliciesAPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of databricks-sdk-java Show documentation
There is a newer version: 0.38.0
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.compute;

import com.databricks.sdk.core.ApiClient;
import com.databricks.sdk.support.Generated;
import com.databricks.sdk.support.Paginator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 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.
 */
@Generated
public class ClusterPoliciesAPI {
  private static final Logger LOG = LoggerFactory.getLogger(ClusterPoliciesAPI.class);

  private final ClusterPoliciesService impl;

  /** Regular-use constructor */
  public ClusterPoliciesAPI(ApiClient apiClient) {
    impl = new ClusterPoliciesImpl(apiClient);
  }

  /** Constructor for mocks */
  public ClusterPoliciesAPI(ClusterPoliciesService mock) {
    impl = mock;
  }

  /**
   * Create a new policy.
   *
   * 
Creates a new policy with prescribed settings.
   */
  public CreatePolicyResponse create(CreatePolicy request) {
    return impl.create(request);
  }

  public void delete(String policyId) {
    delete(new DeletePolicy().setPolicyId(policyId));
  }

  /**
   * Delete a cluster policy.
   *
   * 
Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be
   * edited.
   */
  public void delete(DeletePolicy request) {
    impl.delete(request);
  }

  public void edit(String policyId) {
    edit(new EditPolicy().setPolicyId(policyId));
  }

  /**
   * Update a cluster policy.
   *
   * 
Update an existing policy for cluster. This operation may make some clusters governed by the
   * previous policy invalid.
   */
  public void edit(EditPolicy request) {
    impl.edit(request);
  }

  public Policy get(String policyId) {
    return get(new GetClusterPolicyRequest().setPolicyId(policyId));
  }

  /**
   * Get a cluster policy.
   *
   * 
Get a cluster policy entity. Creation and editing is available to admins only.
   */
  public Policy get(GetClusterPolicyRequest request) {
    return impl.get(request);
  }

  public GetClusterPolicyPermissionLevelsResponse getPermissionLevels(String clusterPolicyId) {
    return getPermissionLevels(
        new GetClusterPolicyPermissionLevelsRequest().setClusterPolicyId(clusterPolicyId));
  }

  /**
   * Get cluster policy permission levels.
   *
   * 
Gets the permission levels that a user can have on an object.
   */
  public GetClusterPolicyPermissionLevelsResponse getPermissionLevels(
      GetClusterPolicyPermissionLevelsRequest request) {
    return impl.getPermissionLevels(request);
  }

  public ClusterPolicyPermissions getPermissions(String clusterPolicyId) {
    return getPermissions(
        new GetClusterPolicyPermissionsRequest().setClusterPolicyId(clusterPolicyId));
  }

  /**
   * Get cluster policy permissions.
   *
   * 
Gets the permissions of a cluster policy. Cluster policies can inherit permissions from
   * their root object.
   */
  public ClusterPolicyPermissions getPermissions(GetClusterPolicyPermissionsRequest request) {
    return impl.getPermissions(request);
  }

  /**
   * List cluster policies.
   *
   * 
Returns a list of policies accessible by the requesting user.
   */
  public Iterable list(ListClusterPoliciesRequest request) {
    return new Paginator<>(
        request, impl::list, ListPoliciesResponse::getPolicies, response -> null);
  }

  public ClusterPolicyPermissions setPermissions(String clusterPolicyId) {
    return setPermissions(
        new ClusterPolicyPermissionsRequest().setClusterPolicyId(clusterPolicyId));
  }

  /**
   * Set cluster policy permissions.
   *
   * 
Sets permissions on a cluster policy. Cluster policies can inherit permissions from their
   * root object.
   */
  public ClusterPolicyPermissions setPermissions(ClusterPolicyPermissionsRequest request) {
    return impl.setPermissions(request);
  }

  public ClusterPolicyPermissions updatePermissions(String clusterPolicyId) {
    return updatePermissions(
        new ClusterPolicyPermissionsRequest().setClusterPolicyId(clusterPolicyId));
  }

  /**
   * Update cluster policy permissions.
   *
   * Updates the permissions on a cluster policy. Cluster policies can inherit permissions from
   * their root object.
   */
  public ClusterPolicyPermissions updatePermissions(ClusterPolicyPermissionsRequest request) {
    return impl.updatePermissions(request);
  }

  public ClusterPoliciesService impl() {
    return impl;
  }
}