Package com.databricks.sdk.service.jobs

Interface Summary

Interface	Description
JobsService	The Jobs API allows you to create, edit, and delete jobs.
PolicyComplianceForJobsService	The compliance APIs allow you to view and manage the policy compliance status of jobs in your workspace.

Class Summary

Class	Description
AlertTask
AlertTaskOutput
AlertTaskSubscriber	Represents a subscriber that will receive alert notifications.
BaseJob
BaseRun
CancelAllRuns
CancelRun
CleanRoomsNotebookTask	Clean Rooms notebook task for V1 Clean Room service (GA).
CleanRoomsNotebookTaskCleanRoomsNotebookTaskOutput
CleanRoomTaskRunState	Stores the run state of the clean rooms notebook task.
ClusterInstance
ClusterSpec
Compute
ComputeConfig
ConditionTask
Continuous
CreateJob
CreateResponse	Job was created successfully
CronSchedule
DashboardPageSnapshot
DashboardTask	Configures the Lakeview Dashboard job task type.
DashboardTaskOutput
DbtCloudJobRunStep	Format of response retrieved from dbt Cloud, for inclusion in output Deprecated in favor of DbtPlatformJobRunStep
DbtCloudTask	Deprecated in favor of DbtPlatformTask
DbtCloudTaskOutput	Deprecated in favor of DbtPlatformTaskOutput
DbtOutput
DbtPlatformJobRunStep	Format of response retrieved from dbt platform, for inclusion in output
DbtPlatformTask
DbtPlatformTaskOutput
DbtTask
DeleteJob
DeleteRun
EnforcePolicyComplianceForJobResponseJobClusterSettingsChange	Represents a change to the job cluster's settings that would be required for the job clusters to become compliant with their policies.
EnforcePolicyComplianceRequest
EnforcePolicyComplianceResponse
ExportRunOutput	Run was exported successfully.
ExportRunRequest
FileArrivalTriggerConfiguration
FileArrivalTriggerState
ForEachStats
ForEachTask
ForEachTaskErrorMessageStats
ForEachTaskTaskRunStats
GenAiComputeTask
GetJobPermissionLevelsRequest
GetJobPermissionLevelsResponse
GetJobPermissionsRequest
GetJobRequest
GetPolicyComplianceRequest
GetPolicyComplianceResponse
GetRunOutputRequest
GetRunRequest
GitSnapshot	Read-only state of the remote repository at the time the job was run.
GitSource	An optional specification for a remote Git repository containing the source code used by tasks.
Job	Job was retrieved successfully.
JobAccessControlRequest
JobAccessControlResponse
JobCluster
JobCompliance
JobDeployment
JobEmailNotifications
JobEnvironment
JobNotificationSettings
JobParameter
JobParameterDefinition
JobPermission
JobPermissions
JobPermissionsDescription
JobPermissionsRequest
JobRunAs	Write-only setting.
JobsAPI	The Jobs API allows you to create, edit, and delete jobs.
JobSettings
JobsHealthRule
JobsHealthRules	An optional set of health rules that can be defined for this job.
JobSource	The source of the job specification in the remote repository when the job is source controlled.
ListJobComplianceForPolicyResponse
ListJobComplianceRequest
ListJobsRequest
ListJobsResponse	List of jobs was retrieved successfully.
ListRunsRequest
ListRunsResponse	List of runs was retrieved successfully.
ModelTriggerConfiguration
NotebookOutput
NotebookTask
OutputSchemaInfo	Stores the catalog name, schema name, and the output schema expiration time for the clean room run.
PeriodicTriggerConfiguration
PipelineParams
PipelineTask
PolicyComplianceForJobsAPI	The compliance APIs allow you to view and manage the policy compliance status of jobs in your workspace.
PowerBiModel
PowerBiTable
PowerBiTask
PythonOperatorTask
PythonOperatorTaskParameter
PythonWheelTask
QueueDetails
QueueSettings
RepairHistoryItem
RepairRun
RepairRunResponse	Run repair was initiated.
ResetJob
ResolvedConditionTaskValues
ResolvedDbtTaskValues
ResolvedNotebookTaskValues
ResolvedParamPairValues
ResolvedPythonWheelTaskValues
ResolvedRunJobTaskValues
ResolvedStringParamsValues
ResolvedValues
Run	Run was retrieved successfully
RunConditionTask
RunForEachTask
RunJobOutput
RunJobTask
RunNow
RunNowResponse	Run was started successfully.
RunOutput	Run output was retrieved successfully.
RunParameters
RunState	The current state of the run.
RunStatus	The current status of the run
RunTask	Used when outputting a child run, in GetRun or ListRuns.
SparkJarTask
SparkPythonTask
SparkSubmitTask
SparseCheckout
SqlAlertOutput
SqlDashboardOutput
SqlDashboardWidgetOutput
SqlOutput
SqlOutputError
SqlQueryOutput
SqlStatementOutput
SqlTask
SqlTaskAlert
SqlTaskDashboard
SqlTaskFile
SqlTaskQuery
SqlTaskSubscription
SubmitRun
SubmitRunResponse	Run was created and started successfully.
SubmitTask
Subscription
SubscriptionSubscriber
TableState
TableTriggerState
TableUpdateTriggerConfiguration
Task
TaskDependency
TaskEmailNotifications
TaskNotificationSettings
TerminationDetails
TriggerInfo	Additional details about what triggered the run
TriggerSettings
TriggerStateProto
UpdateJob
ViewItem
Webhook
WebhookNotifications
WidgetErrorDetail

Enum Summary

Enum	Description
AlertEvaluationState	Same alert evaluation state as in redash-v2/api/proto/alertsv2/alerts.proto
AuthenticationMethod
CleanRoomTaskRunLifeCycleState	Copied from elastic-spark-common/api/messages/runs.proto.
CleanRoomTaskRunResultState	Copied from elastic-spark-common/api/messages/runs.proto.
Condition
ConditionTaskOp	* `EQUAL_TO`, `NOT_EQUAL` operators perform string comparison of their operands.
DbtPlatformRunStatus	Response enumeration from calling the dbt platform API, for inclusion in output
Format
GitProvider
JobDeploymentKind	* `BUNDLE`: The job is managed by Databricks Asset Bundle. * `SYSTEM_MANAGED`: The job is managed by Databricks and is read-only.
JobEditMode	Edit mode of the job.
JobPermissionLevel	Permission level
JobsHealthMetric	Specifies the health metric that is being evaluated for a particular health rule.
JobsHealthOperator	Specifies the operator used to compare the health metric value with the specified threshold.
JobSourceDirtyState	Dirty state indicates the job is not fully synced with the job specification in the remote repository.
ModelTriggerConfigurationCondition
PauseStatus
PerformanceTarget	PerformanceTarget defines how performant (lower latency) or cost efficient the execution of run on serverless compute should be.
PeriodicTriggerConfigurationTimeUnit
QueueDetailsCodeCode	The reason for queuing the run. * `ACTIVE_RUNS_LIMIT_REACHED`: The run was queued due to reaching the workspace limit of active task runs. * `MAX_CONCURRENT_RUNS_REACHED`: The run was queued due to reaching the per-job limit of concurrent job runs. * `ACTIVE_RUN_JOB_TASKS_LIMIT_REACHED`: The run was queued due to reaching the workspace limit of active run job tasks.
RepairHistoryItemType	The repair history item type.
RunIf	An optional value indicating the condition that determines whether the task should be run once its dependencies have been completed.
RunLifeCycleState	A value indicating the run's lifecycle state.
RunLifecycleStateV2State	The current state of the run.
RunResultState	A value indicating the run's result.
RunType	The type of a run. * `JOB_RUN`: Normal job run.
Source	Optional location type of the SQL file.
SqlAlertState	The state of the SQL alert.
SqlDashboardWidgetOutputStatus
StorageMode
TaskRetryMode	task retry mode of the continuous job * NEVER: The failed task will not be retried. * ON_FAILURE: Retry a failed task if at least one other task in the job is still running its first attempt.
TerminationCodeCode	The code indicates why the run was terminated.
TerminationTypeType	* `SUCCESS`: The run terminated without any issues * `INTERNAL_ERROR`: An error occurred in the Databricks platform.
TriggerType	The type of trigger that fired this run.
ViewsToExport	* `CODE`: Code view of the notebook. * `DASHBOARDS`: All dashboard views of the notebook. * `ALL`: All views of the notebook.
ViewType	`NOTEBOOK`: Notebook view item. * `DASHBOARD`: Dashboard view item.