com.databricks.sdk.service.jobs.JobSettings Maven / Gradle / Ivy
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.jobs;
import com.databricks.sdk.support.Generated;
import com.databricks.sdk.support.ToStringer;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.util.Collection;
import java.util.Map;
import java.util.Objects;
@Generated
public class JobSettings {
/**
* An optional continuous property for this job. The continuous property will ensure that there is
* always one run executing. Only one of `schedule` and `continuous` can be used.
*/
@JsonProperty("continuous")
private Continuous continuous;
/** Deployment information for jobs managed by external sources. */
@JsonProperty("deployment")
private JobDeployment deployment;
/**
* An optional description for the job. The maximum length is 27700 characters in UTF-8 encoding.
*/
@JsonProperty("description")
private String description;
/**
* Edit mode of the job.
*
* * `UI_LOCKED`: The job is in a locked UI state and cannot be modified. * `EDITABLE`: The job
* is in an editable state and can be modified.
*/
@JsonProperty("edit_mode")
private JobEditMode editMode;
/**
* An optional set of email addresses that is notified when runs of this job begin or complete as
* well as when this job is deleted.
*/
@JsonProperty("email_notifications")
private JobEmailNotifications emailNotifications;
/**
* A list of task execution environment specifications that can be referenced by tasks of this
* job.
*/
@JsonProperty("environments")
private Collection environments;
/**
* Used to tell what is the format of the job. This field is ignored in Create/Update/Reset calls.
* When using the Jobs API 2.1 this value is always set to `"MULTI_TASK"`.
*/
@JsonProperty("format")
private Format format;
/**
* An optional specification for a remote Git repository containing the source code used by tasks.
* Version-controlled source code is supported by notebook, dbt, Python script, and SQL File
* tasks.
*
* If `git_source` is set, these tasks retrieve the file from the remote repository by default.
* However, this behavior can be overridden by setting `source` to `WORKSPACE` on the task.
*
*
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.
*/
@JsonProperty("git_source")
private GitSource gitSource;
/** An optional set of health rules that can be defined for this job. */
@JsonProperty("health")
private JobsHealthRules health;
/**
* 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
* task settings.
*/
@JsonProperty("job_clusters")
private Collection jobClusters;
/**
* An optional maximum allowed number of concurrent runs of the job. Set this value if you want to
* be able to execute multiple runs of the same job concurrently. This is useful for example if
* you trigger your job on a frequent schedule and want to allow consecutive runs to overlap with
* each other, or if you want to trigger multiple runs which differ by their input parameters.
* This setting affects only new runs. For example, suppose the job’s concurrency is 4 and there
* are 4 concurrent active runs. Then setting the concurrency to 3 won’t kill any of the active
* runs. However, from then on, new runs are skipped unless there are fewer than 3 active runs.
* This value cannot exceed 1000. Setting this value to `0` causes all new runs to be skipped.
*/
@JsonProperty("max_concurrent_runs")
private Long maxConcurrentRuns;
/** An optional name for the job. The maximum length is 4096 bytes in UTF-8 encoding. */
@JsonProperty("name")
private String name;
/**
* Optional notification settings that are used when sending notifications to each of the
* `email_notifications` and `webhook_notifications` for this job.
*/
@JsonProperty("notification_settings")
private JobNotificationSettings notificationSettings;
/** Job-level parameter definitions */
@JsonProperty("parameters")
private Collection parameters;
/** The queue settings of the job. */
@JsonProperty("queue")
private QueueSettings queue;
/**
* Write-only setting, available only in Create/Update/Reset and Submit calls. Specifies the user
* or service principal that the job runs as. If not specified, the job runs as the user who
* created the job.
*
* Only `user_name` or `service_principal_name` can be specified. If both are specified, an
* error is thrown.
*/
@JsonProperty("run_as")
private JobRunAs runAs;
/**
* An optional periodic schedule for this job. The default behavior is that the job only runs when
* triggered by clicking “Run Now” in the Jobs UI or sending an API request to `runNow`.
*/
@JsonProperty("schedule")
private CronSchedule schedule;
/**
* A map of tags associated with the job. These are forwarded to the cluster as cluster tags for
* jobs clusters, and are subject to the same limitations as cluster tags. A maximum of 25 tags
* can be added to the job.
*/
@JsonProperty("tags")
private Map tags;
/** A list of task specifications to be executed by this job. */
@JsonProperty("tasks")
private Collection tasks;
/** An optional timeout applied to each run of this job. A value of `0` means no timeout. */
@JsonProperty("timeout_seconds")
private Long timeoutSeconds;
/**
* A configuration to trigger a run when certain conditions are met. The default behavior is that
* the job runs only when triggered by clicking “Run Now” in the Jobs UI or sending an API request
* to `runNow`.
*/
@JsonProperty("trigger")
private TriggerSettings trigger;
/** A collection of system notification IDs to notify when runs of this job begin or complete. */
@JsonProperty("webhook_notifications")
private WebhookNotifications webhookNotifications;
public JobSettings setContinuous(Continuous continuous) {
this.continuous = continuous;
return this;
}
public Continuous getContinuous() {
return continuous;
}
public JobSettings setDeployment(JobDeployment deployment) {
this.deployment = deployment;
return this;
}
public JobDeployment getDeployment() {
return deployment;
}
public JobSettings setDescription(String description) {
this.description = description;
return this;
}
public String getDescription() {
return description;
}
public JobSettings setEditMode(JobEditMode editMode) {
this.editMode = editMode;
return this;
}
public JobEditMode getEditMode() {
return editMode;
}
public JobSettings setEmailNotifications(JobEmailNotifications emailNotifications) {
this.emailNotifications = emailNotifications;
return this;
}
public JobEmailNotifications getEmailNotifications() {
return emailNotifications;
}
public JobSettings setEnvironments(Collection environments) {
this.environments = environments;
return this;
}
public Collection getEnvironments() {
return environments;
}
public JobSettings setFormat(Format format) {
this.format = format;
return this;
}
public Format getFormat() {
return format;
}
public JobSettings setGitSource(GitSource gitSource) {
this.gitSource = gitSource;
return this;
}
public GitSource getGitSource() {
return gitSource;
}
public JobSettings setHealth(JobsHealthRules health) {
this.health = health;
return this;
}
public JobsHealthRules getHealth() {
return health;
}
public JobSettings setJobClusters(Collection jobClusters) {
this.jobClusters = jobClusters;
return this;
}
public Collection getJobClusters() {
return jobClusters;
}
public JobSettings setMaxConcurrentRuns(Long maxConcurrentRuns) {
this.maxConcurrentRuns = maxConcurrentRuns;
return this;
}
public Long getMaxConcurrentRuns() {
return maxConcurrentRuns;
}
public JobSettings setName(String name) {
this.name = name;
return this;
}
public String getName() {
return name;
}
public JobSettings setNotificationSettings(JobNotificationSettings notificationSettings) {
this.notificationSettings = notificationSettings;
return this;
}
public JobNotificationSettings getNotificationSettings() {
return notificationSettings;
}
public JobSettings setParameters(Collection parameters) {
this.parameters = parameters;
return this;
}
public Collection getParameters() {
return parameters;
}
public JobSettings setQueue(QueueSettings queue) {
this.queue = queue;
return this;
}
public QueueSettings getQueue() {
return queue;
}
public JobSettings setRunAs(JobRunAs runAs) {
this.runAs = runAs;
return this;
}
public JobRunAs getRunAs() {
return runAs;
}
public JobSettings setSchedule(CronSchedule schedule) {
this.schedule = schedule;
return this;
}
public CronSchedule getSchedule() {
return schedule;
}
public JobSettings setTags(Map tags) {
this.tags = tags;
return this;
}
public Map getTags() {
return tags;
}
public JobSettings setTasks(Collection tasks) {
this.tasks = tasks;
return this;
}
public Collection getTasks() {
return tasks;
}
public JobSettings setTimeoutSeconds(Long timeoutSeconds) {
this.timeoutSeconds = timeoutSeconds;
return this;
}
public Long getTimeoutSeconds() {
return timeoutSeconds;
}
public JobSettings setTrigger(TriggerSettings trigger) {
this.trigger = trigger;
return this;
}
public TriggerSettings getTrigger() {
return trigger;
}
public JobSettings setWebhookNotifications(WebhookNotifications webhookNotifications) {
this.webhookNotifications = webhookNotifications;
return this;
}
public WebhookNotifications getWebhookNotifications() {
return webhookNotifications;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
JobSettings that = (JobSettings) o;
return Objects.equals(continuous, that.continuous)
&& Objects.equals(deployment, that.deployment)
&& Objects.equals(description, that.description)
&& Objects.equals(editMode, that.editMode)
&& Objects.equals(emailNotifications, that.emailNotifications)
&& Objects.equals(environments, that.environments)
&& Objects.equals(format, that.format)
&& Objects.equals(gitSource, that.gitSource)
&& Objects.equals(health, that.health)
&& Objects.equals(jobClusters, that.jobClusters)
&& Objects.equals(maxConcurrentRuns, that.maxConcurrentRuns)
&& Objects.equals(name, that.name)
&& Objects.equals(notificationSettings, that.notificationSettings)
&& Objects.equals(parameters, that.parameters)
&& Objects.equals(queue, that.queue)
&& Objects.equals(runAs, that.runAs)
&& Objects.equals(schedule, that.schedule)
&& Objects.equals(tags, that.tags)
&& Objects.equals(tasks, that.tasks)
&& Objects.equals(timeoutSeconds, that.timeoutSeconds)
&& Objects.equals(trigger, that.trigger)
&& Objects.equals(webhookNotifications, that.webhookNotifications);
}
@Override
public int hashCode() {
return Objects.hash(
continuous,
deployment,
description,
editMode,
emailNotifications,
environments,
format,
gitSource,
health,
jobClusters,
maxConcurrentRuns,
name,
notificationSettings,
parameters,
queue,
runAs,
schedule,
tags,
tasks,
timeoutSeconds,
trigger,
webhookNotifications);
}
@Override
public String toString() {
return new ToStringer(JobSettings.class)
.add("continuous", continuous)
.add("deployment", deployment)
.add("description", description)
.add("editMode", editMode)
.add("emailNotifications", emailNotifications)
.add("environments", environments)
.add("format", format)
.add("gitSource", gitSource)
.add("health", health)
.add("jobClusters", jobClusters)
.add("maxConcurrentRuns", maxConcurrentRuns)
.add("name", name)
.add("notificationSettings", notificationSettings)
.add("parameters", parameters)
.add("queue", queue)
.add("runAs", runAs)
.add("schedule", schedule)
.add("tags", tags)
.add("tasks", tasks)
.add("timeoutSeconds", timeoutSeconds)
.add("trigger", trigger)
.add("webhookNotifications", webhookNotifications)
.toString();
}
}