com.databricks.sdk.service.jobs.SubmitRun 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.Objects;
@Generated
public class SubmitRun {
/** List of permissions to set on the job. */
@JsonProperty("access_control_list")
private Collection accessControlList;
/**
* The user specified id of the budget policy to use for this one-time run. If not specified, the
* run will be not be attributed to any budget policy.
*/
@JsonProperty("budget_policy_id")
private String budgetPolicyId;
/** An optional set of email addresses notified when the run begins or completes. */
@JsonProperty("email_notifications")
private JobEmailNotifications emailNotifications;
/**
* A list of task execution environment specifications that can be referenced by tasks of this
* run.
*/
@JsonProperty("environments")
private Collection environments;
/**
* 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;
/**
* An optional token that can be used to guarantee the idempotency of job run requests. If a run
* with the provided token already exists, the request does not create a new run but returns the
* ID of the existing run instead. If a run with the provided token is deleted, an error is
* returned.
*
*
If you specify the idempotency token, upon failure you can retry until the request succeeds.
* Databricks guarantees that exactly one run is launched with that idempotency token.
*
*
This token must have at most 64 characters.
*
*
For more information, see [How to ensure idempotency for jobs].
*
*
[How to ensure idempotency for jobs]: https://kb.databricks.com/jobs/jobs-idempotency.html
*/
@JsonProperty("idempotency_token")
private String idempotencyToken;
/**
* Optional notification settings that are used when sending notifications to each of the
* `email_notifications` and `webhook_notifications` for this run.
*/
@JsonProperty("notification_settings")
private JobNotificationSettings notificationSettings;
/** The queue settings of the one-time run. */
@JsonProperty("queue")
private QueueSettings queue;
/**
* Specifies the user or service principal that the job runs as. If not specified, the job runs as
* the user who submits the request.
*/
@JsonProperty("run_as")
private JobRunAs runAs;
/** An optional name for the run. The default value is `Untitled`. */
@JsonProperty("run_name")
private String runName;
/** */
@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 collection of system notification IDs to notify when the run begins or completes. */
@JsonProperty("webhook_notifications")
private WebhookNotifications webhookNotifications;
public SubmitRun setAccessControlList(Collection accessControlList) {
this.accessControlList = accessControlList;
return this;
}
public Collection getAccessControlList() {
return accessControlList;
}
public SubmitRun setBudgetPolicyId(String budgetPolicyId) {
this.budgetPolicyId = budgetPolicyId;
return this;
}
public String getBudgetPolicyId() {
return budgetPolicyId;
}
public SubmitRun setEmailNotifications(JobEmailNotifications emailNotifications) {
this.emailNotifications = emailNotifications;
return this;
}
public JobEmailNotifications getEmailNotifications() {
return emailNotifications;
}
public SubmitRun setEnvironments(Collection environments) {
this.environments = environments;
return this;
}
public Collection getEnvironments() {
return environments;
}
public SubmitRun setGitSource(GitSource gitSource) {
this.gitSource = gitSource;
return this;
}
public GitSource getGitSource() {
return gitSource;
}
public SubmitRun setHealth(JobsHealthRules health) {
this.health = health;
return this;
}
public JobsHealthRules getHealth() {
return health;
}
public SubmitRun setIdempotencyToken(String idempotencyToken) {
this.idempotencyToken = idempotencyToken;
return this;
}
public String getIdempotencyToken() {
return idempotencyToken;
}
public SubmitRun setNotificationSettings(JobNotificationSettings notificationSettings) {
this.notificationSettings = notificationSettings;
return this;
}
public JobNotificationSettings getNotificationSettings() {
return notificationSettings;
}
public SubmitRun setQueue(QueueSettings queue) {
this.queue = queue;
return this;
}
public QueueSettings getQueue() {
return queue;
}
public SubmitRun setRunAs(JobRunAs runAs) {
this.runAs = runAs;
return this;
}
public JobRunAs getRunAs() {
return runAs;
}
public SubmitRun setRunName(String runName) {
this.runName = runName;
return this;
}
public String getRunName() {
return runName;
}
public SubmitRun setTasks(Collection tasks) {
this.tasks = tasks;
return this;
}
public Collection getTasks() {
return tasks;
}
public SubmitRun setTimeoutSeconds(Long timeoutSeconds) {
this.timeoutSeconds = timeoutSeconds;
return this;
}
public Long getTimeoutSeconds() {
return timeoutSeconds;
}
public SubmitRun 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;
SubmitRun that = (SubmitRun) o;
return Objects.equals(accessControlList, that.accessControlList)
&& Objects.equals(budgetPolicyId, that.budgetPolicyId)
&& Objects.equals(emailNotifications, that.emailNotifications)
&& Objects.equals(environments, that.environments)
&& Objects.equals(gitSource, that.gitSource)
&& Objects.equals(health, that.health)
&& Objects.equals(idempotencyToken, that.idempotencyToken)
&& Objects.equals(notificationSettings, that.notificationSettings)
&& Objects.equals(queue, that.queue)
&& Objects.equals(runAs, that.runAs)
&& Objects.equals(runName, that.runName)
&& Objects.equals(tasks, that.tasks)
&& Objects.equals(timeoutSeconds, that.timeoutSeconds)
&& Objects.equals(webhookNotifications, that.webhookNotifications);
}
@Override
public int hashCode() {
return Objects.hash(
accessControlList,
budgetPolicyId,
emailNotifications,
environments,
gitSource,
health,
idempotencyToken,
notificationSettings,
queue,
runAs,
runName,
tasks,
timeoutSeconds,
webhookNotifications);
}
@Override
public String toString() {
return new ToStringer(SubmitRun.class)
.add("accessControlList", accessControlList)
.add("budgetPolicyId", budgetPolicyId)
.add("emailNotifications", emailNotifications)
.add("environments", environments)
.add("gitSource", gitSource)
.add("health", health)
.add("idempotencyToken", idempotencyToken)
.add("notificationSettings", notificationSettings)
.add("queue", queue)
.add("runAs", runAs)
.add("runName", runName)
.add("tasks", tasks)
.add("timeoutSeconds", timeoutSeconds)
.add("webhookNotifications", webhookNotifications)
.toString();
}
}