com.databricks.sdk.service.jobs.RunNow 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 RunNow {
/**
* An array of commands to execute for jobs with the dbt task, for example `"dbt_commands": ["dbt
* deps", "dbt seed", "dbt run"]`
*/
@JsonProperty("dbt_commands")
private Collection dbtCommands;
/**
* An optional token 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;
/**
* A list of parameters for jobs with Spark JAR tasks, for example `\"jar_params\": [\"john doe\",
* \"35\"]`. The parameters are used to invoke the main function of the main class specified in
* the Spark JAR task. If not specified upon `run-now`, it defaults to an empty list. jar_params
* cannot be specified in conjunction with notebook_params. The JSON representation of this field
* (for example `{\"jar_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.
*
*
Use [Task parameter variables](/jobs.html"#parameter-variables") to set parameters
* containing information about job runs.
*/
@JsonProperty("jar_params")
private Collection jarParams;
/** The ID of the job to be executed */
@JsonProperty("job_id")
private Long jobId;
/** Job-level parameters used in the run */
@JsonProperty("job_parameters")
private Collection> jobParameters;
/**
* A map from keys to values for jobs with notebook task, for example `\"notebook_params\":
* {\"name\": \"john doe\", \"age\": \"35\"}`. The map is passed to the notebook and is accessible
* through the [dbutils.widgets.get] function.
*
* If not specified upon `run-now`, the triggered run uses the job’s base parameters.
*
*
notebook_params cannot be specified in conjunction with jar_params.
*
*
Use [Task parameter variables] to set parameters containing information about job runs.
*
*
The JSON representation of this field (for example `{\"notebook_params\":{\"name\":\"john
* doe\",\"age\":\"35\"}}`) cannot exceed 10,000 bytes.
*
*
[Task parameter variables]: https://docs.databricks.com/jobs.html#parameter-variables
* [dbutils.widgets.get]: https://docs.databricks.com/dev-tools/databricks-utils.html
*/
@JsonProperty("notebook_params")
private Map notebookParams;
/** */
@JsonProperty("pipeline_params")
private PipelineParams pipelineParams;
/**
* A map from keys to values for jobs with Python wheel task, for example `"python_named_params":
* {"name": "task", "data": "dbfs:/path/to/data.json"}`.
*/
@JsonProperty("python_named_params")
private Map pythonNamedParams;
/**
* A list of parameters for jobs with Python tasks, for example `\"python_params\": [\"john doe\",
* \"35\"]`. The parameters are passed to Python file as command-line parameters. If specified
* upon `run-now`, it would overwrite the parameters specified in job setting. The JSON
* representation of this field (for example `{\"python_params\":[\"john doe\",\"35\"]}`) cannot
* exceed 10,000 bytes.
*
* Use [Task parameter variables] to set parameters containing information about job runs.
*
*
Important
*
*
These parameters accept only Latin characters (ASCII character set). Using non-ASCII
* characters returns an error. Examples of invalid, non-ASCII characters are Chinese, Japanese
* kanjis, and emojis.
*
*
[Task parameter variables]: https://docs.databricks.com/jobs.html#parameter-variables
*/
@JsonProperty("python_params")
private Collection pythonParams;
/**
* A list of parameters for jobs with spark submit task, for example `\"spark_submit_params\":
* [\"--class\", \"org.apache.spark.examples.SparkPi\"]`. The parameters are passed to
* spark-submit script as command-line parameters. If specified upon `run-now`, it would overwrite
* the parameters specified in job setting. The JSON representation of this field (for example
* `{\"python_params\":[\"john doe\",\"35\"]}`) cannot exceed 10,000 bytes.
*
* Use [Task parameter variables] to set parameters containing information about job runs
*
*
Important
*
*
These parameters accept only Latin characters (ASCII character set). Using non-ASCII
* characters returns an error. Examples of invalid, non-ASCII characters are Chinese, Japanese
* kanjis, and emojis.
*
*
[Task parameter variables]: https://docs.databricks.com/jobs.html#parameter-variables
*/
@JsonProperty("spark_submit_params")
private Collection sparkSubmitParams;
/**
* A map from keys to values for jobs with SQL task, for example `"sql_params": {"name": "john
* doe", "age": "35"}`. The SQL alert task does not support custom parameters.
*/
@JsonProperty("sql_params")
private Map sqlParams;
public RunNow setDbtCommands(Collection dbtCommands) {
this.dbtCommands = dbtCommands;
return this;
}
public Collection getDbtCommands() {
return dbtCommands;
}
public RunNow setIdempotencyToken(String idempotencyToken) {
this.idempotencyToken = idempotencyToken;
return this;
}
public String getIdempotencyToken() {
return idempotencyToken;
}
public RunNow setJarParams(Collection jarParams) {
this.jarParams = jarParams;
return this;
}
public Collection getJarParams() {
return jarParams;
}
public RunNow setJobId(Long jobId) {
this.jobId = jobId;
return this;
}
public Long getJobId() {
return jobId;
}
public RunNow setJobParameters(Collection> jobParameters) {
this.jobParameters = jobParameters;
return this;
}
public Collection> getJobParameters() {
return jobParameters;
}
public RunNow setNotebookParams(Map notebookParams) {
this.notebookParams = notebookParams;
return this;
}
public Map getNotebookParams() {
return notebookParams;
}
public RunNow setPipelineParams(PipelineParams pipelineParams) {
this.pipelineParams = pipelineParams;
return this;
}
public PipelineParams getPipelineParams() {
return pipelineParams;
}
public RunNow setPythonNamedParams(Map pythonNamedParams) {
this.pythonNamedParams = pythonNamedParams;
return this;
}
public Map getPythonNamedParams() {
return pythonNamedParams;
}
public RunNow setPythonParams(Collection pythonParams) {
this.pythonParams = pythonParams;
return this;
}
public Collection getPythonParams() {
return pythonParams;
}
public RunNow setSparkSubmitParams(Collection sparkSubmitParams) {
this.sparkSubmitParams = sparkSubmitParams;
return this;
}
public Collection getSparkSubmitParams() {
return sparkSubmitParams;
}
public RunNow setSqlParams(Map sqlParams) {
this.sqlParams = sqlParams;
return this;
}
public Map getSqlParams() {
return sqlParams;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
RunNow that = (RunNow) o;
return Objects.equals(dbtCommands, that.dbtCommands)
&& Objects.equals(idempotencyToken, that.idempotencyToken)
&& Objects.equals(jarParams, that.jarParams)
&& Objects.equals(jobId, that.jobId)
&& Objects.equals(jobParameters, that.jobParameters)
&& Objects.equals(notebookParams, that.notebookParams)
&& Objects.equals(pipelineParams, that.pipelineParams)
&& Objects.equals(pythonNamedParams, that.pythonNamedParams)
&& Objects.equals(pythonParams, that.pythonParams)
&& Objects.equals(sparkSubmitParams, that.sparkSubmitParams)
&& Objects.equals(sqlParams, that.sqlParams);
}
@Override
public int hashCode() {
return Objects.hash(
dbtCommands,
idempotencyToken,
jarParams,
jobId,
jobParameters,
notebookParams,
pipelineParams,
pythonNamedParams,
pythonParams,
sparkSubmitParams,
sqlParams);
}
@Override
public String toString() {
return new ToStringer(RunNow.class)
.add("dbtCommands", dbtCommands)
.add("idempotencyToken", idempotencyToken)
.add("jarParams", jarParams)
.add("jobId", jobId)
.add("jobParameters", jobParameters)
.add("notebookParams", notebookParams)
.add("pipelineParams", pipelineParams)
.add("pythonNamedParams", pythonNamedParams)
.add("pythonParams", pythonParams)
.add("sparkSubmitParams", sparkSubmitParams)
.add("sqlParams", sqlParams)
.toString();
}
}