com.databricks.sdk.service.compute

Interface PolicyComplianceForClustersService

@Generated
public interface PolicyComplianceForClustersService

The policy compliance APIs allow you to view and manage the policy compliance status of clusters in your workspace.

A cluster is compliant with its policy if its configuration satisfies all its policy rules. Clusters could be out of compliance if their policy was updated after the cluster was last edited.

The get and list compliance APIs allow you to view the policy compliance status of a cluster. The enforce compliance API allows you to update a cluster to be compliant with the current version of its policy.

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
EnforceClusterComplianceResponse	enforceCompliance(EnforceClusterComplianceRequest enforceClusterComplianceRequest) Updates a cluster to be compliant with the current version of its policy.
GetClusterComplianceResponse	getCompliance(GetClusterComplianceRequest getClusterComplianceRequest) Returns the policy compliance status of a cluster.
ListClusterCompliancesResponse	listCompliance(ListClusterCompliancesRequest listClusterCompliancesRequest) Returns the policy compliance status of all clusters that use a given policy.

Method Detail

enforceCompliance

EnforceClusterComplianceResponse enforceCompliance(EnforceClusterComplianceRequest enforceClusterComplianceRequest)

Updates a cluster to be compliant with the current version of its policy. A cluster can be updated if it is in a `RUNNING` or `TERMINATED` state.

If a cluster is updated while in a `RUNNING` state, it will be restarted so that the new attributes can take effect.

If a cluster is updated while in a `TERMINATED` state, it will remain `TERMINATED`. The next time the cluster is started, the new attributes will take effect.

Clusters created by the Databricks Jobs, DLT, or Models services cannot be enforced by this API. Instead, use the "Enforce job policy compliance" API to enforce policy compliance on jobs.

getCompliance

GetClusterComplianceResponse getCompliance(GetClusterComplianceRequest getClusterComplianceRequest)

Returns the policy compliance status of a cluster. Clusters could be out of compliance if their policy was updated after the cluster was last edited.

listCompliance

ListClusterCompliancesResponse listCompliance(ListClusterCompliancesRequest listClusterCompliancesRequest)

Returns the policy compliance status of all clusters that use a given policy. Clusters could be out of compliance if their policy was updated after the cluster was last edited.