com.databricks.sdk.service.jobs

Class PolicyComplianceForJobsAPI

java.lang.Object

com.databricks.sdk.service.jobs.PolicyComplianceForJobsAPI

@Generated
public class PolicyComplianceForJobsAPI
extends Object

The compliance APIs allow you to view and manage the policy compliance status of jobs in your workspace. This API currently only supports compliance controls for cluster policies.

A job is in compliance if its cluster configurations satisfy the rules of all their respective cluster policies. A job could be out of compliance if a cluster policy it uses was updated after the job was last edited. The job is considered out of compliance if any of its clusters no longer comply with their updated policies.

The get and list compliance APIs allow you to view the policy compliance status of a job. The enforce compliance API allows you to update a job so that it becomes compliant with all of its policies.

Constructor Summary

Constructors

Constructor and Description
PolicyComplianceForJobsAPI(ApiClient apiClient) Regular-use constructor
PolicyComplianceForJobsAPI(PolicyComplianceForJobsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
EnforcePolicyComplianceResponse	enforceCompliance(EnforcePolicyComplianceRequest request) Enforce job policy compliance.
EnforcePolicyComplianceResponse	enforceCompliance(long jobId)
GetPolicyComplianceResponse	getCompliance(GetPolicyComplianceRequest request) Get job policy compliance.
GetPolicyComplianceResponse	getCompliance(long jobId)
PolicyComplianceForJobsService	impl()
Iterable<JobCompliance>	listCompliance(ListJobComplianceRequest request) List job policy compliance.
Iterable<JobCompliance>	listCompliance(String policyId)

Methods inherited from class java.lang.Object

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

Constructor Detail

PolicyComplianceForJobsAPI

public PolicyComplianceForJobsAPI(ApiClient apiClient)

Regular-use constructor

PolicyComplianceForJobsAPI

public PolicyComplianceForJobsAPI(PolicyComplianceForJobsService mock)

Constructor for mocks

Method Detail

enforceCompliance

public EnforcePolicyComplianceResponse enforceCompliance(long jobId)

enforceCompliance

public EnforcePolicyComplianceResponse enforceCompliance(EnforcePolicyComplianceRequest request)

Enforce job policy compliance.

Updates a job so the job clusters that are created when running the job (specified in `new_cluster`) are compliant with the current versions of their respective cluster policies. All-purpose clusters used in the job will not be updated.

getCompliance

public GetPolicyComplianceResponse getCompliance(long jobId)

getCompliance

public GetPolicyComplianceResponse getCompliance(GetPolicyComplianceRequest request)

Get job policy compliance.

Returns the policy compliance status of a job. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and some of its job clusters no longer comply with their updated policies.

listCompliance

public Iterable<JobCompliance> listCompliance(String policyId)

listCompliance

public Iterable<JobCompliance> listCompliance(ListJobComplianceRequest request)

List job policy compliance.

Returns the policy compliance status of all jobs that use a given policy. Jobs could be out of compliance if a cluster policy they use was updated after the job was last edited and its job clusters no longer comply with the updated policy.

impl

public PolicyComplianceForJobsService impl()