databricks-sdk 0.29.0__py3-none-any.whl → 0.31.0__py3-none-any.whl

databricks/sdk/service/jobs.py

@@ -15,7 +15,7 @@ from ._internal import Wait, _enum, _from_dict, _repeated_dict
 
 _LOG = logging.getLogger('databricks.sdk')
 
-from databricks.sdk.service import compute, iam
+from databricks.sdk.service import compute
 
 # all definitions in this file are in alphabetical order
 
@@ -58,8 +58,8 @@ class BaseJob:
 class BaseRun:
     attempt_number: Optional[int] = None
     """The sequence number of this run attempt for a triggered job run. The initial attempt of a run
-    has an attempt_number of 0\. If the initial run attempt fails, and the job has a retry policy
-    (`max_retries` \> 0), subsequent runs are created with an `original_attempt_run_id` of the
+    has an attempt_number of 0. If the initial run attempt fails, and the job has a retry policy
+    (`max_retries` > 0), subsequent runs are created with an `original_attempt_run_id` of the
     original attempt’s ID and an incrementing `attempt_number`. Runs are retried only until they
     succeed, and the maximum `attempt_number` is the same as the `max_retries` value for the job."""
 
@@ -115,6 +115,11 @@ class BaseRun:
     job_parameters: Optional[List[JobParameter]] = None
     """Job-level parameters used in the run"""
 
+    job_run_id: Optional[int] = None
+    """ID of the job run that this run belongs to. For legacy and single-task job runs the field is
+    populated with the job run ID. For task runs, the field is populated with the ID of the job run
+    that the task run belongs to."""
+
     number_in_job: Optional[int] = None
     """A unique identifier for this job run. This is set to the same value as `run_id`."""
 
@@ -201,6 +206,7 @@ class BaseRun:
         if self.job_clusters: body['job_clusters'] = [v.as_dict() for v in self.job_clusters]
         if self.job_id is not None: body['job_id'] = self.job_id
         if self.job_parameters: body['job_parameters'] = [v.as_dict() for v in self.job_parameters]
+        if self.job_run_id is not None: body['job_run_id'] = self.job_run_id
         if self.number_in_job is not None: body['number_in_job'] = self.number_in_job
         if self.original_attempt_run_id is not None:
             body['original_attempt_run_id'] = self.original_attempt_run_id
@@ -236,6 +242,7 @@ class BaseRun:
                    job_clusters=_repeated_dict(d, 'job_clusters', JobCluster),
                    job_id=d.get('job_id', None),
                    job_parameters=_repeated_dict(d, 'job_parameters', JobParameter),
+                   job_run_id=d.get('job_run_id', None),
                    number_in_job=d.get('number_in_job', None),
                    original_attempt_run_id=d.get('original_attempt_run_id', None),
                    overriding_parameters=_from_dict(d, 'overriding_parameters', RunParameters),
@@ -469,7 +476,7 @@ class Continuous:
 
 @dataclass
 class CreateJob:
-    access_control_list: Optional[List[iam.AccessControlRequest]] = None
+    access_control_list: Optional[List[JobAccessControlRequest]] = None
     """List of permissions to set on the job."""
 
     continuous: Optional[Continuous] = None
@@ -480,7 +487,7 @@ class CreateJob:
     """Deployment information for jobs managed by external sources."""
 
     description: Optional[str] = None
-    """An optional description for the job. The maximum length is 1024 characters in UTF-8 encoding."""
+    """An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding."""
 
     edit_mode: Optional[JobEditMode] = None
     """Edit mode of the job.
@@ -603,7 +610,7 @@ class CreateJob:
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> CreateJob:
         """Deserializes the CreateJob from a dictionary."""
-        return cls(access_control_list=_repeated_dict(d, 'access_control_list', iam.AccessControlRequest),
+        return cls(access_control_list=_repeated_dict(d, 'access_control_list', JobAccessControlRequest),
                    continuous=_from_dict(d, 'continuous', Continuous),
                    deployment=_from_dict(d, 'deployment', JobDeployment),
                    description=d.get('description', None),
@@ -827,6 +834,96 @@ class DeleteRunResponse:
         return cls()
 
 
+@dataclass
+class EnforcePolicyComplianceForJobResponseJobClusterSettingsChange:
+    """Represents a change to the job cluster's settings that would be required for the job clusters to
+    become compliant with their policies."""
+
+    field: Optional[str] = None
+    """The field where this change would be made, prepended with the job cluster key."""
+
+    new_value: Optional[str] = None
+    """The new value of this field after enforcing policy compliance (either a number, a boolean, or a
+    string) converted to a string. This is intended to be read by a human. The typed new value of
+    this field can be retrieved by reading the settings field in the API response."""
+
+    previous_value: Optional[str] = None
+    """The previous value of this field before enforcing policy compliance (either a number, a boolean,
+    or a string) converted to a string. This is intended to be read by a human. The type of the
+    field can be retrieved by reading the settings field in the API response."""
+
+    def as_dict(self) -> dict:
+        """Serializes the EnforcePolicyComplianceForJobResponseJobClusterSettingsChange into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.field is not None: body['field'] = self.field
+        if self.new_value is not None: body['new_value'] = self.new_value
+        if self.previous_value is not None: body['previous_value'] = self.previous_value
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> EnforcePolicyComplianceForJobResponseJobClusterSettingsChange:
+        """Deserializes the EnforcePolicyComplianceForJobResponseJobClusterSettingsChange from a dictionary."""
+        return cls(field=d.get('field', None),
+                   new_value=d.get('new_value', None),
+                   previous_value=d.get('previous_value', None))
+
+
+@dataclass
+class EnforcePolicyComplianceRequest:
+    job_id: int
+    """The ID of the job you want to enforce policy compliance on."""
+
+    validate_only: Optional[bool] = None
+    """If set, previews changes made to the job to comply with its policy, but does not update the job."""
+
+    def as_dict(self) -> dict:
+        """Serializes the EnforcePolicyComplianceRequest into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.job_id is not None: body['job_id'] = self.job_id
+        if self.validate_only is not None: body['validate_only'] = self.validate_only
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> EnforcePolicyComplianceRequest:
+        """Deserializes the EnforcePolicyComplianceRequest from a dictionary."""
+        return cls(job_id=d.get('job_id', None), validate_only=d.get('validate_only', None))
+
+
+@dataclass
+class EnforcePolicyComplianceResponse:
+    has_changes: Optional[bool] = None
+    """Whether any changes have been made to the job cluster settings for the job to become compliant
+    with its policies."""
+
+    job_cluster_changes: Optional[List[EnforcePolicyComplianceForJobResponseJobClusterSettingsChange]] = None
+    """A list of job cluster changes that have been made to the job’s cluster settings in order for
+    all job clusters to become compliant with their policies."""
+
+    settings: Optional[JobSettings] = None
+    """Updated job settings after policy enforcement. Policy enforcement only applies to job clusters
+    that are created when running the job (which are specified in new_cluster) and does not apply to
+    existing all-purpose clusters. Updated job settings are derived by applying policy default
+    values to the existing job clusters in order to satisfy policy requirements."""
+
+    def as_dict(self) -> dict:
+        """Serializes the EnforcePolicyComplianceResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.has_changes is not None: body['has_changes'] = self.has_changes
+        if self.job_cluster_changes:
+            body['job_cluster_changes'] = [v.as_dict() for v in self.job_cluster_changes]
+        if self.settings: body['settings'] = self.settings.as_dict()
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> EnforcePolicyComplianceResponse:
+        """Deserializes the EnforcePolicyComplianceResponse from a dictionary."""
+        return cls(has_changes=d.get('has_changes', None),
+                   job_cluster_changes=_repeated_dict(
+                       d, 'job_cluster_changes',
+                       EnforcePolicyComplianceForJobResponseJobClusterSettingsChange),
+                   settings=_from_dict(d, 'settings', JobSettings))
+
+
 @dataclass
 class ExportRunOutput:
     """Run was exported successfully."""
@@ -914,7 +1011,8 @@ class ForEachTask:
     """Configuration for the task that will be run for each element in the array"""
 
     concurrency: Optional[int] = None
-    """Controls the number of active iterations task runs. Default is 20, maximum allowed is 100."""
+    """An optional maximum allowed number of concurrent runs of the task. Set this value if you want to
+    be able to execute multiple runs of the task concurrently."""
 
     def as_dict(self) -> dict:
         """Serializes the ForEachTask into a dictionary suitable for use as a JSON request body."""
@@ -1024,6 +1122,32 @@ class GetJobPermissionLevelsResponse:
         return cls(permission_levels=_repeated_dict(d, 'permission_levels', JobPermissionsDescription))
 
 
+@dataclass
+class GetPolicyComplianceResponse:
+    is_compliant: Optional[bool] = None
+    """Whether the job is compliant with its policies or not. Jobs could be out of compliance if a
+    policy they are using was updated after the job was last edited and some of its job clusters no
+    longer comply with their updated policies."""
+
+    violations: Optional[Dict[str, str]] = None
+    """An object containing key-value mappings representing the first 200 policy validation errors. The
+    keys indicate the path where the policy validation error is occurring. An identifier for the job
+    cluster is prepended to the path. The values indicate an error message describing the policy
+    validation error."""
+
+    def as_dict(self) -> dict:
+        """Serializes the GetPolicyComplianceResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.is_compliant is not None: body['is_compliant'] = self.is_compliant
+        if self.violations: body['violations'] = self.violations
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> GetPolicyComplianceResponse:
+        """Deserializes the GetPolicyComplianceResponse from a dictionary."""
+        return cls(is_compliant=d.get('is_compliant', None), violations=d.get('violations', None))
+
+
 class GitProvider(Enum):
 
     AWS_CODE_COMMIT = 'awsCodeCommit'
@@ -1260,6 +1384,36 @@ class JobCluster:
                    new_cluster=_from_dict(d, 'new_cluster', compute.ClusterSpec))
 
 
+@dataclass
+class JobCompliance:
+    job_id: int
+    """Canonical unique identifier for a job."""
+
+    is_compliant: Optional[bool] = None
+    """Whether this job is in compliance with the latest version of its policy."""
+
+    violations: Optional[Dict[str, str]] = None
+    """An object containing key-value mappings representing the first 200 policy validation errors. The
+    keys indicate the path where the policy validation error is occurring. An identifier for the job
+    cluster is prepended to the path. The values indicate an error message describing the policy
+    validation error."""
+
+    def as_dict(self) -> dict:
+        """Serializes the JobCompliance into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.is_compliant is not None: body['is_compliant'] = self.is_compliant
+        if self.job_id is not None: body['job_id'] = self.job_id
+        if self.violations: body['violations'] = self.violations
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> JobCompliance:
+        """Deserializes the JobCompliance from a dictionary."""
+        return cls(is_compliant=d.get('is_compliant', None),
+                   job_id=d.get('job_id', None),
+                   violations=d.get('violations', None))
+
+
 @dataclass
 class JobDeployment:
     kind: JobDeploymentKind
@@ -1601,7 +1755,7 @@ class JobSettings:
     """Deployment information for jobs managed by external sources."""
 
     description: Optional[str] = None
-    """An optional description for the job. The maximum length is 1024 characters in UTF-8 encoding."""
+    """An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding."""
 
     edit_mode: Optional[JobEditMode] = None
     """Edit mode of the job.
@@ -1874,6 +2028,35 @@ class JobsHealthRules:
         return cls(rules=_repeated_dict(d, 'rules', JobsHealthRule))
 
 
+@dataclass
+class ListJobComplianceForPolicyResponse:
+    jobs: Optional[List[JobCompliance]] = None
+    """A list of jobs and their policy compliance statuses."""
+
+    next_page_token: Optional[str] = None
+    """This field represents the pagination token to retrieve the next page of results. If this field
+    is not in the response, it means no further results for the request."""
+
+    prev_page_token: Optional[str] = None
+    """This field represents the pagination token to retrieve the previous page of results. If this
+    field is not in the response, it means no further results for the request."""
+
+    def as_dict(self) -> dict:
+        """Serializes the ListJobComplianceForPolicyResponse into a dictionary suitable for use as a JSON request body."""
+        body = {}
+        if self.jobs: body['jobs'] = [v.as_dict() for v in self.jobs]
+        if self.next_page_token is not None: body['next_page_token'] = self.next_page_token
+        if self.prev_page_token is not None: body['prev_page_token'] = self.prev_page_token
+        return body
+
+    @classmethod
+    def from_dict(cls, d: Dict[str, any]) -> ListJobComplianceForPolicyResponse:
+        """Deserializes the ListJobComplianceForPolicyResponse from a dictionary."""
+        return cls(jobs=_repeated_dict(d, 'jobs', JobCompliance),
+                   next_page_token=d.get('next_page_token', None),
+                   prev_page_token=d.get('prev_page_token', None))
+
+
 @dataclass
 class ListJobsResponse:
     """List of jobs was retrieved successfully."""
@@ -2055,7 +2238,6 @@ class PeriodicTriggerConfigurationTimeUnit(Enum):
 
     DAYS = 'DAYS'
     HOURS = 'HOURS'
-    TIME_UNIT_UNSPECIFIED = 'TIME_UNIT_UNSPECIFIED'
     WEEKS = 'WEEKS'
 
 
@@ -2569,8 +2751,8 @@ class Run:
 
     attempt_number: Optional[int] = None
     """The sequence number of this run attempt for a triggered job run. The initial attempt of a run
-    has an attempt_number of 0\. If the initial run attempt fails, and the job has a retry policy
-    (`max_retries` \> 0), subsequent runs are created with an `original_attempt_run_id` of the
+    has an attempt_number of 0. If the initial run attempt fails, and the job has a retry policy
+    (`max_retries` > 0), subsequent runs are created with an `original_attempt_run_id` of the
     original attempt’s ID and an incrementing `attempt_number`. Runs are retried only until they
     succeed, and the maximum `attempt_number` is the same as the `max_retries` value for the job."""
 
@@ -2615,6 +2797,9 @@ class Run:
     Note: dbt and SQL File tasks support only version-controlled sources. If dbt or SQL File tasks
     are used, `git_source` must be defined on the job."""
 
+    iterations: Optional[List[RunTask]] = None
+    """Only populated by for-each iterations. The parent for-each task is located in tasks array."""
+
     job_clusters: Optional[List[JobCluster]] = None
     """A list of job cluster specifications that can be shared and reused by tasks of this job.
     Libraries cannot be declared in a shared job cluster. You must declare dependent libraries in
@@ -2626,6 +2811,14 @@ class Run:
     job_parameters: Optional[List[JobParameter]] = None
     """Job-level parameters used in the run"""
 
+    job_run_id: Optional[int] = None
+    """ID of the job run that this run belongs to. For legacy and single-task job runs the field is
+    populated with the job run ID. For task runs, the field is populated with the ID of the job run
+    that the task run belongs to."""
+
+    next_page_token: Optional[str] = None
+    """A token that can be used to list the next page of sub-resources."""
+
     number_in_job: Optional[int] = None
     """A unique identifier for this job run. This is set to the same value as `run_id`."""
 
@@ -2636,6 +2829,9 @@ class Run:
     overriding_parameters: Optional[RunParameters] = None
     """The parameters used for this run."""
 
+    prev_page_token: Optional[str] = None
+    """A token that can be used to list the previous page of sub-resources."""
+
     queue_duration: Optional[int] = None
     """The time in milliseconds that the run has spent in the queue."""
 
@@ -2709,13 +2905,17 @@ class Run:
         if self.end_time is not None: body['end_time'] = self.end_time
         if self.execution_duration is not None: body['execution_duration'] = self.execution_duration
         if self.git_source: body['git_source'] = self.git_source.as_dict()
+        if self.iterations: body['iterations'] = [v.as_dict() for v in self.iterations]
         if self.job_clusters: body['job_clusters'] = [v.as_dict() for v in self.job_clusters]
         if self.job_id is not None: body['job_id'] = self.job_id
         if self.job_parameters: body['job_parameters'] = [v.as_dict() for v in self.job_parameters]
+        if self.job_run_id is not None: body['job_run_id'] = self.job_run_id
+        if self.next_page_token is not None: body['next_page_token'] = self.next_page_token
         if self.number_in_job is not None: body['number_in_job'] = self.number_in_job
         if self.original_attempt_run_id is not None:
             body['original_attempt_run_id'] = self.original_attempt_run_id
         if self.overriding_parameters: body['overriding_parameters'] = self.overriding_parameters.as_dict()
+        if self.prev_page_token is not None: body['prev_page_token'] = self.prev_page_token
         if self.queue_duration is not None: body['queue_duration'] = self.queue_duration
         if self.repair_history: body['repair_history'] = [v.as_dict() for v in self.repair_history]
         if self.run_duration is not None: body['run_duration'] = self.run_duration
@@ -2744,12 +2944,16 @@ class Run:
                    end_time=d.get('end_time', None),
                    execution_duration=d.get('execution_duration', None),
                    git_source=_from_dict(d, 'git_source', GitSource),
+                   iterations=_repeated_dict(d, 'iterations', RunTask),
                    job_clusters=_repeated_dict(d, 'job_clusters', JobCluster),
                    job_id=d.get('job_id', None),
                    job_parameters=_repeated_dict(d, 'job_parameters', JobParameter),
+                   job_run_id=d.get('job_run_id', None),
+                   next_page_token=d.get('next_page_token', None),
                    number_in_job=d.get('number_in_job', None),
                    original_attempt_run_id=d.get('original_attempt_run_id', None),
                    overriding_parameters=_from_dict(d, 'overriding_parameters', RunParameters),
+                   prev_page_token=d.get('prev_page_token', None),
                    queue_duration=d.get('queue_duration', None),
                    repair_history=_repeated_dict(d, 'repair_history', RepairHistoryItem),
                    run_duration=d.get('run_duration', None),
@@ -2818,7 +3022,8 @@ class RunForEachTask:
     """Configuration for the task that will be run for each element in the array"""
 
     concurrency: Optional[int] = None
-    """Controls the number of active iterations task runs. Default is 20, maximum allowed is 100."""
+    """An optional maximum allowed number of concurrent runs of the task. Set this value if you want to
+    be able to execute multiple runs of the task concurrently."""
 
     stats: Optional[ForEachStats] = None
     """Read only field. Populated for GetRun and ListRuns RPC calls and stores the execution stats of
@@ -3415,8 +3620,8 @@ class RunTask:
 
     attempt_number: Optional[int] = None
     """The sequence number of this run attempt for a triggered job run. The initial attempt of a run
-    has an attempt_number of 0\. If the initial run attempt fails, and the job has a retry policy
-    (`max_retries` \> 0), subsequent runs are created with an `original_attempt_run_id` of the
+    has an attempt_number of 0. If the initial run attempt fails, and the job has a retry policy
+    (`max_retries` > 0), subsequent runs are created with an `original_attempt_run_id` of the
     original attempt’s ID and an incrementing `attempt_number`. Runs are retried only until they
     succeed, and the maximum `attempt_number` is the same as the `max_retries` value for the job."""
 
@@ -4188,7 +4393,7 @@ class SqlTaskSubscription:
 
 @dataclass
 class SubmitRun:
-    access_control_list: Optional[List[iam.AccessControlRequest]] = None
+    access_control_list: Optional[List[JobAccessControlRequest]] = None
     """List of permissions to set on the job."""
 
     email_notifications: Optional[JobEmailNotifications] = None
@@ -4268,7 +4473,7 @@ class SubmitRun:
     @classmethod
     def from_dict(cls, d: Dict[str, any]) -> SubmitRun:
         """Deserializes the SubmitRun from a dictionary."""
-        return cls(access_control_list=_repeated_dict(d, 'access_control_list', iam.AccessControlRequest),
+        return cls(access_control_list=_repeated_dict(d, 'access_control_list', JobAccessControlRequest),
                    email_notifications=_from_dict(d, 'email_notifications', JobEmailNotifications),
                    environments=_repeated_dict(d, 'environments', JobEnvironment),
                    git_source=_from_dict(d, 'git_source', GitSource),
@@ -5157,7 +5362,7 @@ class JobsAPI:
 
     def create(self,
                *,
-               access_control_list: Optional[List[iam.AccessControlRequest]] = None,
+               access_control_list: Optional[List[JobAccessControlRequest]] = None,
                continuous: Optional[Continuous] = None,
                deployment: Optional[JobDeployment] = None,
                description: Optional[str] = None,
@@ -5184,7 +5389,7 @@ class JobsAPI:
         
         Create a new job.
         
-        :param access_control_list: List[:class:`AccessControlRequest`] (optional)
+        :param access_control_list: List[:class:`JobAccessControlRequest`] (optional)
           List of permissions to set on the job.
         :param continuous: :class:`Continuous` (optional)
           An optional continuous property for this job. The continuous property will ensure that there is
@@ -5192,7 +5397,7 @@ class JobsAPI:
         :param deployment: :class:`JobDeployment` (optional)
           Deployment information for jobs managed by external sources.
         :param description: str (optional)
-          An optional description for the job. The maximum length is 1024 characters in UTF-8 encoding.
+          An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.
         :param edit_mode: :class:`JobEditMode` (optional)
           Edit mode of the job.
           
@@ -5402,7 +5607,8 @@ class JobsAPI:
                 run_id: int,
                 *,
                 include_history: Optional[bool] = None,
-                include_resolved_values: Optional[bool] = None) -> Run:
+                include_resolved_values: Optional[bool] = None,
+                page_token: Optional[str] = None) -> Run:
         """Get a single job run.
         
         Retrieve the metadata of a run.
@@ -5413,6 +5619,9 @@ class JobsAPI:
           Whether to include the repair history in the response.
         :param include_resolved_values: bool (optional)
           Whether to include resolved parameter values in the response.
+        :param page_token: str (optional)
+          To list the next page or the previous page of job tasks, set this field to the value of the
+          `next_page_token` or `prev_page_token` returned in the GetJob response.
         
         :returns: :class:`Run`
         """
@@ -5420,6 +5629,7 @@ class JobsAPI:
         query = {}
         if include_history is not None: query['include_history'] = include_history
         if include_resolved_values is not None: query['include_resolved_values'] = include_resolved_values
+        if page_token is not None: query['page_token'] = page_token
         if run_id is not None: query['run_id'] = run_id
         headers = {'Accept': 'application/json', }
 
@@ -5927,7 +6137,7 @@ class JobsAPI:
 
     def submit(self,
                *,
-               access_control_list: Optional[List[iam.AccessControlRequest]] = None,
+               access_control_list: Optional[List[JobAccessControlRequest]] = None,
                email_notifications: Optional[JobEmailNotifications] = None,
                environments: Optional[List[JobEnvironment]] = None,
                git_source: Optional[GitSource] = None,
@@ -5946,7 +6156,7 @@ class JobsAPI:
         Runs submitted using this endpoint don’t display in the UI. Use the `jobs/runs/get` API to check the
         run state after the job is submitted.
         
-        :param access_control_list: List[:class:`AccessControlRequest`] (optional)
+        :param access_control_list: List[:class:`JobAccessControlRequest`] (optional)
           List of permissions to set on the job.
         :param email_notifications: :class:`JobEmailNotifications` (optional)
           An optional set of email addresses notified when the run begins or completes.
@@ -6021,7 +6231,7 @@ class JobsAPI:
     def submit_and_wait(
         self,
         *,
-        access_control_list: Optional[List[iam.AccessControlRequest]] = None,
+        access_control_list: Optional[List[JobAccessControlRequest]] = None,
         email_notifications: Optional[JobEmailNotifications] = None,
         environments: Optional[List[JobEnvironment]] = None,
         git_source: Optional[GitSource] = None,
@@ -6108,3 +6318,102 @@ class JobsAPI:
 
         res = self._api.do('PATCH', f'/api/2.0/permissions/jobs/{job_id}', body=body, headers=headers)
         return JobPermissions.from_dict(res)
+
+
+class PolicyComplianceForJobsAPI:
+    """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."""
+
+    def __init__(self, api_client):
+        self._api = api_client
+
+    def enforce_compliance(self,
+                           job_id: int,
+                           *,
+                           validate_only: Optional[bool] = None) -> EnforcePolicyComplianceResponse:
+        """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.
+        
+        :param job_id: int
+          The ID of the job you want to enforce policy compliance on.
+        :param validate_only: bool (optional)
+          If set, previews changes made to the job to comply with its policy, but does not update the job.
+        
+        :returns: :class:`EnforcePolicyComplianceResponse`
+        """
+        body = {}
+        if job_id is not None: body['job_id'] = job_id
+        if validate_only is not None: body['validate_only'] = validate_only
+        headers = {'Accept': 'application/json', 'Content-Type': 'application/json', }
+
+        res = self._api.do('POST', '/api/2.0/policies/jobs/enforce-compliance', body=body, headers=headers)
+        return EnforcePolicyComplianceResponse.from_dict(res)
+
+    def get_compliance(self, job_id: int) -> GetPolicyComplianceResponse:
+        """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.
+        
+        :param job_id: int
+          The ID of the job whose compliance status you are requesting.
+        
+        :returns: :class:`GetPolicyComplianceResponse`
+        """
+
+        query = {}
+        if job_id is not None: query['job_id'] = job_id
+        headers = {'Accept': 'application/json', }
+
+        res = self._api.do('GET', '/api/2.0/policies/jobs/get-compliance', query=query, headers=headers)
+        return GetPolicyComplianceResponse.from_dict(res)
+
+    def list_compliance(self,
+                        policy_id: str,
+                        *,
+                        page_size: Optional[int] = None,
+                        page_token: Optional[str] = None) -> Iterator[JobCompliance]:
+        """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.
+        
+        :param policy_id: str
+          Canonical unique identifier for the cluster policy.
+        :param page_size: int (optional)
+          Use this field to specify the maximum number of results to be returned by the server. The server may
+          further constrain the maximum number of results returned in a single page.
+        :param page_token: str (optional)
+          A page token that can be used to navigate to the next page or previous page as returned by
+          `next_page_token` or `prev_page_token`.
+        
+        :returns: Iterator over :class:`JobCompliance`
+        """
+
+        query = {}
+        if page_size is not None: query['page_size'] = page_size
+        if page_token is not None: query['page_token'] = page_token
+        if policy_id is not None: query['policy_id'] = policy_id
+        headers = {'Accept': 'application/json', }
+
+        while True:
+            json = self._api.do('GET', '/api/2.0/policies/jobs/list-compliance', query=query, headers=headers)
+            if 'jobs' in json:
+                for v in json['jobs']:
+                    yield JobCompliance.from_dict(v)
+            if 'next_page_token' not in json or not json['next_page_token']:
+                return
+            query['page_token'] = json['next_page_token']