"description":"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. The default behavior is to not send any emails.",
"properties":{
"no_alert_for_skipped_runs":{
"description":"If true, do not send email to recipients specified in `on_failure` if the run is skipped."
},
"on_failure":{
"description":"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `SKIPPED`, `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_start":{
"description":"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_success":{
"description":"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESSFUL` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
}
}
},
"format":{
"description":"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\"`."
},
"git_source":{
"description":"An optional specification for a remote repository containing the notebooks used by this job's notebook tasks.",
"properties":{
"git_branch":{
"description":"Name of the branch to be checked out and used by this job.\nThis field cannot be specified in conjunction with git_tag or git_commit.\n\nThe maximum length is 255 characters.\n"
},
"git_commit":{
"description":"Commit to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_tag.\nThe maximum length is 64 characters."
},
"git_provider":{
"description":"Unique identifier of the service used to host the Git repository. The value is case insensitive."
},
"git_snapshot":{
"description":"",
"properties":{
"used_commit":{
"description":"Commit that was used to execute the run. If git_branch was specified, this points to the HEAD of the branch at the time of the run; if git_tag was specified, this points to the commit the tag points to."
}
}
},
"git_tag":{
"description":"Name of the tag to be checked out and used by this job.\nThis field cannot be specified in conjunction with git_branch or git_commit.\n\nThe maximum length is 255 characters.\n"
},
"git_url":{
"description":"URL of the repository to be cloned by this job.\nThe maximum length is 300 characters."
}
}
},
"job_clusters":{
"description":"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.",
"items":{
"description":"",
"properties":{
"job_cluster_key":{
"description":"A unique name for the job cluster. This field is required and must be unique within the job.\n`JobTaskSettings` may refer to this field to determine which cluster to launch for the task execution."
},
"new_cluster":{
"description":"If new_cluster, a description of a cluster that is created for each task.",
"properties":{
"autoscale":{
"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.",
"properties":{
"max_workers":{
"description":"The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`."
},
"min_workers":{
"description":"The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation."
}
}
},
"autotermination_minutes":{
"description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination."
},
"aws_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"ebs_volume_count":{
"description":"The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden."
},
"ebs_volume_iops":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_size":{
"description":"The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096."
},
"ebs_volume_throughput":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_type":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"instance_profile_arn":{
"description":"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.\n\nIf this field is ommitted, we will pull in the default from the conf if it exists."
},
"spot_bid_price_percent":{
"description":"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.\n\nThe default value and documentation here should be kept consistent with\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent."
},
"zone_id":{
"description":"Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\nSee [[AutoAZHelper.scala]] for more details.\nThe list of available zones as well as the default value can be found by using the\n`List Zones`_ method."
}
}
},
"azure_attributes":{
"description":"Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"log_analytics_info":{
"description":"Defines values necessary to configure and run Azure Log Analytics agent",
"properties":{
"log_analytics_primary_key":{
"description":"\u003cneeds content added\u003e"
},
"log_analytics_workspace_id":{
"description":"\u003cneeds content added\u003e"
}
}
},
"spot_bid_max_price":{
"description":"The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1."
}
}
},
"cluster_log_conf":{
"description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.",
"properties":{
"dbfs":{
"description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`",
"properties":{
"destination":{
"description":"dbfs destination, e.g. `dbfs:/my/path`"
}
}
},
"s3":{
"description":"destination and either region or endpoint should also be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.",
"properties":{
"canned_acl":{
"description":"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs."
},
"destination":{
"description":"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs."
},
"enable_encryption":{
"description":"(Optional) Flag to enable server side encryption, `false` by default."
},
"encryption_type":{
"description":"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`."
},
"endpoint":{
"description":"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used."
},
"kms_key":{
"description":"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`."
},
"region":{
"description":"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used."
}
}
}
}
},
"cluster_name":{
"description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\n"
},
"cluster_source":{
"description":""
},
"custom_tags":{
"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags",
"additionalproperties":{
"description":""
}
},
"driver_instance_pool_id":{
"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."
},
"driver_node_type_id":{
"description":"The node type of the Spark driver. Note that this field is optional;\nif unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n"
},
"enable_elastic_disk":{
"description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details."
},
"enable_local_disk_encryption":{
"description":"Whether to enable LUKS on cluster VMs' local disks"
},
"gcp_attributes":{
"description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"boot_disk_size":{
"description":"boot disk size in GB"
},
"google_service_account":{
"description":"If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator."
}
}
},
"instance_pool_id":{
"description":"The optional ID of the instance pool to which the cluster belongs."
},
"node_type_id":{
"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"
},
"num_workers":{
"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."
},
"policy_id":{
"description":"The ID of the cluster policy used to create the cluster if applicable."
},
"runtime_engine":{
"description":""
},
"spark_conf":{
"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\n",
"additionalproperties":{
"description":""
}
},
"spark_env_vars":{
"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`",
"additionalproperties":{
"description":""
}
},
"spark_version":{
"description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.\n"
},
"ssh_public_keys":{
"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.",
"items":{
"description":""
}
},
"workload_type":{
"description":"",
"properties":{
"clients":{
"description":" defined what type of clients can use the cluster. E.g. Notebooks, Jobs",
"properties":{
"jobs":{
"description":"With jobs set, the cluster can be used for jobs"
},
"notebooks":{
"description":"With notebooks set, this cluster can be used for notebooks"
}
}
}
}
}
}
}
}
}
},
"max_concurrent_runs":{
"description":"An optional maximum allowed number of concurrent runs of the job.\n\nSet 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.\n\nThis 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.\n\nThis value cannot exceed 1000\\. Setting this value to 0 causes all new runs to be skipped. The default behavior is to allow only 1 concurrent run."
"description":"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`.",
"properties":{
"pause_status":{
"description":"Indicate whether this schedule is paused or not."
},
"quartz_cron_expression":{
"description":"A Cron expression using Quartz syntax that describes the schedule for a job.\nSee [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)\nfor details. This field is required.\"\n"
},
"timezone_id":{
"description":"A Java timezone ID. The schedule for a job is resolved with respect to this timezone.\nSee [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details.\nThis field is required.\n"
}
}
},
"tags":{
"description":"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.",
"additionalproperties":{
"description":""
}
},
"tasks":{
"description":"A list of task specifications to be executed by this job.",
"items":{
"description":"",
"properties":{
"dbt_task":{
"description":"If dbt_task, indicates that this must execute a dbt task. It requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse.",
"properties":{
"catalog":{
"description":"Optional name of the catalog to use. The value is the top level in the 3-level namespace of Unity Catalog (catalog / schema / relation). The catalog value can only be specified if a warehouse_id is specified. Requires dbt-databricks \u003e= 1.1.1."
},
"commands":{
"description":"A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided.",
"items":{
"description":""
}
},
"profiles_directory":{
"description":"Optional (relative) path to the profiles directory. Can only be specified if no warehouse_id is specified. If no warehouse_id is specified and this folder is unset, the root directory is used."
},
"project_directory":{
"description":"Optional (relative) path to the project directory, if no value is provided, the root of the git repository is used."
},
"schema":{
"description":"Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the `default` schema is used."
},
"warehouse_id":{
"description":"ID of the SQL warehouse to connect to. If provided, we automatically generate and provide the profile and connection details to dbt. It can be overridden on a per-command basis by using the `--profiles-dir` command line argument."
}
}
},
"depends_on":{
"description":"",
"items":{
"description":"",
"properties":{
"task_key":{
"description":""
}
}
}
},
"description":{
"description":"An optional description for this task.\nThe maximum length is 4096 bytes."
},
"email_notifications":{
"description":"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. The default behavior is to not send any emails.",
"properties":{
"no_alert_for_skipped_runs":{
"description":"If true, do not send email to recipients specified in `on_failure` if the run is skipped."
},
"on_failure":{
"description":"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `SKIPPED`, `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_start":{
"description":"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_success":{
"description":"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESSFUL` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
}
}
},
"existing_cluster_id":{
"description":"If existing_cluster_id, the ID of an existing cluster that is used for all runs of this task. When running tasks on an existing cluster, you may need to manually restart the cluster if it stops responding. We suggest running jobs on new clusters for greater reliability."
},
"job_cluster_key":{
"description":"If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`."
},
"libraries":{
"description":"An optional list of libraries to be installed on the cluster that executes the task. The default value is an empty list.",
"items":{
"description":"",
"properties":{
"cran":{
"description":"Specification of a CRAN library to be installed as part of the library",
"properties":{
"package":{
"description":"The name of the CRAN package to install."
},
"repo":{
"description":"The repository where the package can be found. If not specified, the default CRAN repo is used."
}
}
},
"egg":{
"description":"URI of the egg to be installed. Currently only DBFS and S3 URIs are supported.\nFor example: `{ \"egg\": \"dbfs:/my/egg\" }` or\n`{ \"egg\": \"s3://my-bucket/egg\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
},
"jar":{
"description":"URI of the jar to be installed. Currently only DBFS and S3 URIs are supported.\nFor example: `{ \"jar\": \"dbfs:/mnt/databricks/library.jar\" }` or\n`{ \"jar\": \"s3://my-bucket/library.jar\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
},
"maven":{
"description":"Specification of a maven library to be installed. For example:\n`{ \"coordinates\": \"org.jsoup:jsoup:1.7.2\" }`",
"properties":{
"coordinates":{
"description":"Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\"."
},
"exclusions":{
"description":"List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.",
"items":{
"description":""
}
},
"repo":{
"description":"Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched."
}
}
},
"pypi":{
"description":"Specification of a PyPi library to be installed. For example:\n`{ \"package\": \"simplejson\" }`",
"properties":{
"package":{
"description":"The name of the pypi package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\"."
},
"repo":{
"description":"The repository where the package can be found. If not specified, the default pip index is\nused."
}
}
},
"whl":{
"description":"URI of the wheel to be installed.\nFor example: `{ \"whl\": \"dbfs:/my/whl\" }` or `{ \"whl\": \"s3://my-bucket/whl\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
}
}
}
},
"max_retries":{
"description":"An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value -1 means to retry indefinitely and the value 0 means to never retry. The default behavior is to never retry."
},
"min_retry_interval_millis":{
"description":"An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried."
},
"new_cluster":{
"description":"If new_cluster, a description of a cluster that is created for each task.",
"properties":{
"autoscale":{
"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.",
"properties":{
"max_workers":{
"description":"The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`."
},
"min_workers":{
"description":"The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation."
}
}
},
"autotermination_minutes":{
"description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination."
},
"aws_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"ebs_volume_count":{
"description":"The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden."
},
"ebs_volume_iops":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_size":{
"description":"The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096."
},
"ebs_volume_throughput":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_type":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"instance_profile_arn":{
"description":"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.\n\nIf this field is ommitted, we will pull in the default from the conf if it exists."
},
"spot_bid_price_percent":{
"description":"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.\n\nThe default value and documentation here should be kept consistent with\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent."
},
"zone_id":{
"description":"Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\nSee [[AutoAZHelper.scala]] for more details.\nThe list of available zones as well as the default value can be found by using the\n`List Zones`_ method."
}
}
},
"azure_attributes":{
"description":"Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"log_analytics_info":{
"description":"Defines values necessary to configure and run Azure Log Analytics agent",
"properties":{
"log_analytics_primary_key":{
"description":"\u003cneeds content added\u003e"
},
"log_analytics_workspace_id":{
"description":"\u003cneeds content added\u003e"
}
}
},
"spot_bid_max_price":{
"description":"The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1."
}
}
},
"cluster_log_conf":{
"description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.",
"properties":{
"dbfs":{
"description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`",
"properties":{
"destination":{
"description":"dbfs destination, e.g. `dbfs:/my/path`"
}
}
},
"s3":{
"description":"destination and either region or endpoint should also be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.",
"properties":{
"canned_acl":{
"description":"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs."
},
"destination":{
"description":"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs."
},
"enable_encryption":{
"description":"(Optional) Flag to enable server side encryption, `false` by default."
},
"encryption_type":{
"description":"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`."
},
"endpoint":{
"description":"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used."
},
"kms_key":{
"description":"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`."
},
"region":{
"description":"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used."
}
}
}
}
},
"cluster_name":{
"description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\n"
},
"cluster_source":{
"description":""
},
"custom_tags":{
"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags",
"additionalproperties":{
"description":""
}
},
"driver_instance_pool_id":{
"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."
},
"driver_node_type_id":{
"description":"The node type of the Spark driver. Note that this field is optional;\nif unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n"
},
"enable_elastic_disk":{
"description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details."
},
"enable_local_disk_encryption":{
"description":"Whether to enable LUKS on cluster VMs' local disks"
},
"gcp_attributes":{
"description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"boot_disk_size":{
"description":"boot disk size in GB"
},
"google_service_account":{
"description":"If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator."
}
}
},
"instance_pool_id":{
"description":"The optional ID of the instance pool to which the cluster belongs."
},
"node_type_id":{
"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"
},
"num_workers":{
"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."
},
"policy_id":{
"description":"The ID of the cluster policy used to create the cluster if applicable."
},
"runtime_engine":{
"description":""
},
"spark_conf":{
"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\n",
"additionalproperties":{
"description":""
}
},
"spark_env_vars":{
"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`",
"additionalproperties":{
"description":""
}
},
"spark_version":{
"description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.\n"
},
"ssh_public_keys":{
"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.",
"items":{
"description":""
}
},
"workload_type":{
"description":"",
"properties":{
"clients":{
"description":" defined what type of clients can use the cluster. E.g. Notebooks, Jobs",
"properties":{
"jobs":{
"description":"With jobs set, the cluster can be used for jobs"
},
"notebooks":{
"description":"With notebooks set, this cluster can be used for notebooks"
}
}
}
}
}
}
},
"notebook_task":{
"description":"If notebook_task, indicates that this task must run a notebook. This field may not be specified in conjunction with spark_jar_task.",
"properties":{
"base_parameters":{
"description":"Base parameters to be used for each run of this job. If the run is initiated by a call to\n:method:jobs/runNow with parameters specified, the two parameters maps are merged. If the same key is specified in\n`base_parameters` and in `run-now`, the value from `run-now` is used.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nIf the notebook takes a parameter that is not specified in the job’s `base_parameters` or the `run-now` override parameters,\nthe default value from the notebook is used.\n\nRetrieve these parameters in a notebook using [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-widgets).\n",
"additionalproperties":{
"description":""
}
},
"notebook_path":{
"description":"The path of the notebook to be run in the Databricks workspace or remote repository.\nFor notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash.\nFor notebooks stored in a remote repository, the path must be relative. This field is required.\n"
},
"source":{
"description":"This describes an enum"
}
}
},
"pipeline_task":{
"description":"If pipeline_task, indicates that this task must execute a Pipeline.",
"properties":{
"full_refresh":{
"description":"If true, a full refresh will be triggered on the delta live table."
},
"pipeline_id":{
"description":"The full name of the pipeline task to execute."
}
}
},
"python_wheel_task":{
"description":"If python_wheel_task, indicates that this job must execute a PythonWheel.",
"properties":{
"entry_point":{
"description":"Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()`"
},
"named_parameters":{
"description":"Command-line parameters passed to Python wheel task in the form of `[\"--name=task\", \"--data=dbfs:/path/to/data.json\"]`. Leave it empty if `parameters` is not null.",
"additionalproperties":{
"description":""
}
},
"package_name":{
"description":"Name of the package to execute"
},
"parameters":{
"description":"Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null.",
"items":{
"description":""
}
}
}
},
"retry_on_timeout":{
"description":"An optional policy to specify whether to retry a task when it times out. The default behavior is to not retry on timeout."
},
"spark_jar_task":{
"description":"If spark_jar_task, indicates that this task must run a JAR.",
"properties":{
"jar_uri":{
"description":"Deprecated since 04/2016\\\\. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create.\n"
},
"main_class_name":{
"description":"The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library.\n\nThe code must use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job fail."
},
"parameters":{
"description":"Parameters passed to the main method.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n",
"items":{
"description":""
}
}
}
},
"spark_python_task":{
"description":"If spark_python_task, indicates that this task must run a Python file.",
"properties":{
"parameters":{
"description":"Command line parameters passed to the Python file.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n",
"items":{
"description":""
}
},
"python_file":{
"description":""
}
}
},
"spark_submit_task":{
"description":"If spark_submit_task, indicates that this task must be launched by the spark submit script. This task can run only on new clusters.",
"properties":{
"parameters":{
"description":"Command-line parameters passed to spark submit.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n",
"items":{
"description":""
}
}
}
},
"sql_task":{
"description":"If sql_task, indicates that this job must execute a SQL task.",
"properties":{
"alert":{
"description":"If alert, indicates that this job must refresh a SQL alert.",
"properties":{
"alert_id":{
"description":"The canonical identifier of the SQL alert."
},
"pause_subscriptions":{
"description":"If true, the alert notifications are not sent to subscribers."
},
"subscriptions":{
"description":"If specified, alert notifications are sent to subscribers.",
"items":{
"description":"",
"properties":{
"destination_id":{
"description":"The canonical identifier of the destination to receive email notification."
},
"user_name":{
"description":"The user name to receive the subscription email."
}
}
}
}
}
},
"dashboard":{
"description":"If dashboard, indicates that this job must refresh a SQL dashboard.",
"properties":{
"custom_subject":{
"description":"Subject of the email sent to subscribers of this task."
},
"dashboard_id":{
"description":"The canonical identifier of the SQL dashboard."
},
"pause_subscriptions":{
"description":"If true, the dashboard snapshot is not taken, and emails are not sent to subscribers."
},
"subscriptions":{
"description":"If specified, dashboard snapshots are sent to subscriptions.",
"items":{
"description":"",
"properties":{
"destination_id":{
"description":"The canonical identifier of the destination to receive email notification."
},
"user_name":{
"description":"The user name to receive the subscription email."
}
}
}
}
}
},
"parameters":{
"description":"Parameters to be used for each run of this job. The SQL alert task does not support custom parameters.",
"additionalproperties":{
"description":""
}
},
"query":{
"description":"If query, indicates that this job must execute a SQL query.",
"properties":{
"query_id":{
"description":"The canonical identifier of the SQL query."
}
}
},
"warehouse_id":{
"description":"The canonical identifier of the SQL warehouse. Only serverless and pro SQL warehouses are supported."
}
}
},
"task_key":{
"description":"A unique name for the task. This field is used to refer to this task from other tasks.\nThis field is required and must be unique within its parent job.\nOn Update or Reset, this field is used to reference the tasks to be updated or reset.\nThe maximum length is 100 characters."
},
"timeout_seconds":{
"description":"An optional timeout applied to each run of this job task. The default behavior is to have no timeout."
}
}
}
},
"timeout_seconds":{
"description":"An optional timeout applied to each run of this job. The default behavior is to have no timeout."
"description":"A collection of system notification IDs to notify when the run begins or completes. The default behavior is to not send any system notifications.",
"properties":{
"on_failure":{
"description":"An optional list of system notification IDs to call when the run fails. A maximum of 3 destinations can be specified for the `on_failure` property.",
"items":{
"description":"",
"properties":{
"id":{
"description":""
}
}
}
},
"on_start":{
"description":"An optional list of system notification IDs to call when the run starts. A maximum of 3 destinations can be specified for the `on_start` property.",
"items":{
"description":"",
"properties":{
"id":{
"description":""
}
}
}
},
"on_success":{
"description":"An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the `on_success` property.",
"description":"Catalog in UC to add tables to. If target is specified, tables in this pipeline will be\npublished to a \"target\" schema inside catalog (i.e. \u003ccatalog\u003e.\u003ctarget\u003e.\u003ctable\u003e)."
},
"channel":{
"description":"DLT Release Channel that specifies which version to use."
},
"clusters":{
"description":"Cluster settings for this pipeline deployment.",
"items":{
"description":"",
"properties":{
"apply_policy_default_values":{
"description":"Note: This field won't be persisted. Only API users will check this field."
},
"autoscale":{
"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.",
"properties":{
"max_workers":{
"description":"The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`."
},
"min_workers":{
"description":"The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation."
}
}
},
"aws_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"ebs_volume_count":{
"description":"The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden."
},
"ebs_volume_iops":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_size":{
"description":"The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096."
},
"ebs_volume_throughput":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_type":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"instance_profile_arn":{
"description":"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.\n\nIf this field is ommitted, we will pull in the default from the conf if it exists."
},
"spot_bid_price_percent":{
"description":"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.\n\nThe default value and documentation here should be kept consistent with\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent."
},
"zone_id":{
"description":"Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\nSee [[AutoAZHelper.scala]] for more details.\nThe list of available zones as well as the default value can be found by using the\n`List Zones`_ method."
}
}
},
"azure_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"log_analytics_info":{
"description":"Defines values necessary to configure and run Azure Log Analytics agent",
"properties":{
"log_analytics_primary_key":{
"description":"\u003cneeds content added\u003e"
},
"log_analytics_workspace_id":{
"description":"\u003cneeds content added\u003e"
}
}
},
"spot_bid_max_price":{
"description":"The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1."
}
}
},
"cluster_log_conf":{
"description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.",
"properties":{
"dbfs":{
"description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`",
"properties":{
"destination":{
"description":"dbfs destination, e.g. `dbfs:/my/path`"
}
}
},
"s3":{
"description":"destination and either region or endpoint should also be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.",
"properties":{
"canned_acl":{
"description":"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs."
},
"destination":{
"description":"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs."
},
"enable_encryption":{
"description":"(Optional) Flag to enable server side encryption, `false` by default."
},
"encryption_type":{
"description":"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`."
},
"endpoint":{
"description":"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used."
},
"kms_key":{
"description":"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`."
},
"region":{
"description":"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used."
}
}
}
}
},
"custom_tags":{
"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags",
"additionalproperties":{
"description":""
}
},
"driver_instance_pool_id":{
"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."
},
"driver_node_type_id":{
"description":"The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above."
},
"gcp_attributes":{
"description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"boot_disk_size":{
"description":"boot disk size in GB"
},
"google_service_account":{
"description":"If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator."
}
}
},
"instance_pool_id":{
"description":"The optional ID of the instance pool to which the cluster belongs."
},
"label":{
"description":"Cluster label"
},
"node_type_id":{
"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"
},
"num_workers":{
"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."
},
"policy_id":{
"description":"The ID of the cluster policy used to create the cluster if applicable."
},
"spark_conf":{
"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nSee :method:clusters/create for more details.\n",
"additionalproperties":{
"description":""
}
},
"spark_env_vars":{
"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`",
"additionalproperties":{
"description":""
}
},
"ssh_public_keys":{
"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.",
"items":{
"description":""
}
}
}
}
},
"configuration":{
"description":"String-String configuration for this pipeline execution.",
"additionalproperties":{
"description":""
}
},
"continuous":{
"description":"Whether the pipeline is continuous or triggered. This replaces `trigger`."
},
"development":{
"description":"Whether the pipeline is in Development mode. Defaults to false."
},
"edition":{
"description":"Pipeline product edition."
},
"filters":{
"description":"Filters on which Pipeline packages to include in the deployed graph.",
"properties":{
"exclude":{
"description":"Paths to exclude.",
"items":{
"description":""
}
},
"include":{
"description":"Paths to include.",
"items":{
"description":""
}
}
}
},
"id":{
"description":"Unique identifier for this pipeline."
},
"libraries":{
"description":"Libraries or code needed by this deployment.",
"description":"URI of the jar to be installed. Currently only DBFS and S3 URIs are supported.\nFor example: `{ \"jar\": \"dbfs:/mnt/databricks/library.jar\" }` or\n`{ \"jar\": \"s3://my-bucket/library.jar\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
},
"maven":{
"description":"Specification of a maven library to be installed. For example:\n`{ \"coordinates\": \"org.jsoup:jsoup:1.7.2\" }`",
"properties":{
"coordinates":{
"description":"Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\"."
},
"exclusions":{
"description":"List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.",
"items":{
"description":""
}
},
"repo":{
"description":"Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched."
}
}
},
"notebook":{
"description":"The path to a notebook that defines a pipeline and is stored in the Databricks workspace.\nFor example: `{ \"notebook\" : { \"path\" : \"/my-pipeline-notebook-path\" } }`.\nCurrently, only Scala notebooks are supported, and pipelines must be defined in a package\ncell.",
"properties":{
"path":{
"description":"The absolute path of the notebook."
}
}
},
"whl":{
"description":"URI of the wheel to be installed.\nFor example: `{ \"whl\": \"dbfs:/my/whl\" }` or `{ \"whl\": \"s3://my-bucket/whl\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
}
}
}
},
"name":{
"description":"Friendly identifier for this pipeline."
"description":"The base location for synchronizing files, artifacts and state. Defaults to `/Users/jane@doe.com/.bundle/${bundle.name}/${bundle.environment}`"
"description":"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. The default behavior is to not send any emails.",
"properties":{
"no_alert_for_skipped_runs":{
"description":"If true, do not send email to recipients specified in `on_failure` if the run is skipped."
},
"on_failure":{
"description":"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `SKIPPED`, `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_start":{
"description":"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_success":{
"description":"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESSFUL` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
}
}
},
"format":{
"description":"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\"`."
},
"git_source":{
"description":"An optional specification for a remote repository containing the notebooks used by this job's notebook tasks.",
"properties":{
"git_branch":{
"description":"Name of the branch to be checked out and used by this job.\nThis field cannot be specified in conjunction with git_tag or git_commit.\n\nThe maximum length is 255 characters.\n"
},
"git_commit":{
"description":"Commit to be checked out and used by this job. This field cannot be specified in conjunction with git_branch or git_tag.\nThe maximum length is 64 characters."
},
"git_provider":{
"description":"Unique identifier of the service used to host the Git repository. The value is case insensitive."
},
"git_snapshot":{
"description":"",
"properties":{
"used_commit":{
"description":"Commit that was used to execute the run. If git_branch was specified, this points to the HEAD of the branch at the time of the run; if git_tag was specified, this points to the commit the tag points to."
}
}
},
"git_tag":{
"description":"Name of the tag to be checked out and used by this job.\nThis field cannot be specified in conjunction with git_branch or git_commit.\n\nThe maximum length is 255 characters.\n"
},
"git_url":{
"description":"URL of the repository to be cloned by this job.\nThe maximum length is 300 characters."
}
}
},
"job_clusters":{
"description":"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.",
"items":{
"description":"",
"properties":{
"job_cluster_key":{
"description":"A unique name for the job cluster. This field is required and must be unique within the job.\n`JobTaskSettings` may refer to this field to determine which cluster to launch for the task execution."
},
"new_cluster":{
"description":"If new_cluster, a description of a cluster that is created for each task.",
"properties":{
"autoscale":{
"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.",
"properties":{
"max_workers":{
"description":"The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`."
},
"min_workers":{
"description":"The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation."
}
}
},
"autotermination_minutes":{
"description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination."
},
"aws_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"ebs_volume_count":{
"description":"The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden."
},
"ebs_volume_iops":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_size":{
"description":"The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096."
},
"ebs_volume_throughput":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_type":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"instance_profile_arn":{
"description":"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.\n\nIf this field is ommitted, we will pull in the default from the conf if it exists."
},
"spot_bid_price_percent":{
"description":"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.\n\nThe default value and documentation here should be kept consistent with\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent."
},
"zone_id":{
"description":"Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\nSee [[AutoAZHelper.scala]] for more details.\nThe list of available zones as well as the default value can be found by using the\n`List Zones`_ method."
}
}
},
"azure_attributes":{
"description":"Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"log_analytics_info":{
"description":"Defines values necessary to configure and run Azure Log Analytics agent",
"properties":{
"log_analytics_primary_key":{
"description":"\u003cneeds content added\u003e"
},
"log_analytics_workspace_id":{
"description":"\u003cneeds content added\u003e"
}
}
},
"spot_bid_max_price":{
"description":"The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1."
}
}
},
"cluster_log_conf":{
"description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.",
"properties":{
"dbfs":{
"description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`",
"properties":{
"destination":{
"description":"dbfs destination, e.g. `dbfs:/my/path`"
}
}
},
"s3":{
"description":"destination and either region or endpoint should also be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.",
"properties":{
"canned_acl":{
"description":"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs."
},
"destination":{
"description":"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs."
},
"enable_encryption":{
"description":"(Optional) Flag to enable server side encryption, `false` by default."
},
"encryption_type":{
"description":"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`."
},
"endpoint":{
"description":"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used."
},
"kms_key":{
"description":"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`."
},
"region":{
"description":"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used."
}
}
}
}
},
"cluster_name":{
"description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\n"
},
"cluster_source":{
"description":""
},
"custom_tags":{
"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags",
"additionalproperties":{
"description":""
}
},
"driver_instance_pool_id":{
"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."
},
"driver_node_type_id":{
"description":"The node type of the Spark driver. Note that this field is optional;\nif unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n"
},
"enable_elastic_disk":{
"description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details."
},
"enable_local_disk_encryption":{
"description":"Whether to enable LUKS on cluster VMs' local disks"
},
"gcp_attributes":{
"description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"boot_disk_size":{
"description":"boot disk size in GB"
},
"google_service_account":{
"description":"If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator."
}
}
},
"instance_pool_id":{
"description":"The optional ID of the instance pool to which the cluster belongs."
},
"node_type_id":{
"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"
},
"num_workers":{
"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."
},
"policy_id":{
"description":"The ID of the cluster policy used to create the cluster if applicable."
},
"runtime_engine":{
"description":""
},
"spark_conf":{
"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\n",
"additionalproperties":{
"description":""
}
},
"spark_env_vars":{
"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`",
"additionalproperties":{
"description":""
}
},
"spark_version":{
"description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.\n"
},
"ssh_public_keys":{
"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.",
"items":{
"description":""
}
},
"workload_type":{
"description":"",
"properties":{
"clients":{
"description":" defined what type of clients can use the cluster. E.g. Notebooks, Jobs",
"properties":{
"jobs":{
"description":"With jobs set, the cluster can be used for jobs"
},
"notebooks":{
"description":"With notebooks set, this cluster can be used for notebooks"
}
}
}
}
}
}
}
}
}
},
"max_concurrent_runs":{
"description":"An optional maximum allowed number of concurrent runs of the job.\n\nSet 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.\n\nThis 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.\n\nThis value cannot exceed 1000\\. Setting this value to 0 causes all new runs to be skipped. The default behavior is to allow only 1 concurrent run."
"description":"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`.",
"properties":{
"pause_status":{
"description":"Indicate whether this schedule is paused or not."
},
"quartz_cron_expression":{
"description":"A Cron expression using Quartz syntax that describes the schedule for a job.\nSee [Cron Trigger](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)\nfor details. This field is required.\"\n"
},
"timezone_id":{
"description":"A Java timezone ID. The schedule for a job is resolved with respect to this timezone.\nSee [Java TimeZone](https://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html) for details.\nThis field is required.\n"
}
}
},
"tags":{
"description":"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.",
"additionalproperties":{
"description":""
}
},
"tasks":{
"description":"A list of task specifications to be executed by this job.",
"items":{
"description":"",
"properties":{
"dbt_task":{
"description":"If dbt_task, indicates that this must execute a dbt task. It requires both Databricks SQL and the ability to use a serverless or a pro SQL warehouse.",
"properties":{
"catalog":{
"description":"Optional name of the catalog to use. The value is the top level in the 3-level namespace of Unity Catalog (catalog / schema / relation). The catalog value can only be specified if a warehouse_id is specified. Requires dbt-databricks \u003e= 1.1.1."
},
"commands":{
"description":"A list of dbt commands to execute. All commands must start with `dbt`. This parameter must not be empty. A maximum of up to 10 commands can be provided.",
"items":{
"description":""
}
},
"profiles_directory":{
"description":"Optional (relative) path to the profiles directory. Can only be specified if no warehouse_id is specified. If no warehouse_id is specified and this folder is unset, the root directory is used."
},
"project_directory":{
"description":"Optional (relative) path to the project directory, if no value is provided, the root of the git repository is used."
},
"schema":{
"description":"Optional schema to write to. This parameter is only used when a warehouse_id is also provided. If not provided, the `default` schema is used."
},
"warehouse_id":{
"description":"ID of the SQL warehouse to connect to. If provided, we automatically generate and provide the profile and connection details to dbt. It can be overridden on a per-command basis by using the `--profiles-dir` command line argument."
}
}
},
"depends_on":{
"description":"",
"items":{
"description":"",
"properties":{
"task_key":{
"description":""
}
}
}
},
"description":{
"description":"An optional description for this task.\nThe maximum length is 4096 bytes."
},
"email_notifications":{
"description":"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. The default behavior is to not send any emails.",
"properties":{
"no_alert_for_skipped_runs":{
"description":"If true, do not send email to recipients specified in `on_failure` if the run is skipped."
},
"on_failure":{
"description":"A list of email addresses to be notified when a run unsuccessfully completes. A run is considered to have completed unsuccessfully if it ends with an `INTERNAL_ERROR` `life_cycle_state` or a `SKIPPED`, `FAILED`, or `TIMED_OUT` result_state. If this is not specified on job creation, reset, or update the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_start":{
"description":"A list of email addresses to be notified when a run begins. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
},
"on_success":{
"description":"A list of email addresses to be notified when a run successfully completes. A run is considered to have completed successfully if it ends with a `TERMINATED` `life_cycle_state` and a `SUCCESSFUL` result_state. If not specified on job creation, reset, or update, the list is empty, and notifications are not sent.",
"items":{
"description":""
}
}
}
},
"existing_cluster_id":{
"description":"If existing_cluster_id, the ID of an existing cluster that is used for all runs of this task. When running tasks on an existing cluster, you may need to manually restart the cluster if it stops responding. We suggest running jobs on new clusters for greater reliability."
},
"job_cluster_key":{
"description":"If job_cluster_key, this task is executed reusing the cluster specified in `job.settings.job_clusters`."
},
"libraries":{
"description":"An optional list of libraries to be installed on the cluster that executes the task. The default value is an empty list.",
"items":{
"description":"",
"properties":{
"cran":{
"description":"Specification of a CRAN library to be installed as part of the library",
"properties":{
"package":{
"description":"The name of the CRAN package to install."
},
"repo":{
"description":"The repository where the package can be found. If not specified, the default CRAN repo is used."
}
}
},
"egg":{
"description":"URI of the egg to be installed. Currently only DBFS and S3 URIs are supported.\nFor example: `{ \"egg\": \"dbfs:/my/egg\" }` or\n`{ \"egg\": \"s3://my-bucket/egg\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
},
"jar":{
"description":"URI of the jar to be installed. Currently only DBFS and S3 URIs are supported.\nFor example: `{ \"jar\": \"dbfs:/mnt/databricks/library.jar\" }` or\n`{ \"jar\": \"s3://my-bucket/library.jar\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
},
"maven":{
"description":"Specification of a maven library to be installed. For example:\n`{ \"coordinates\": \"org.jsoup:jsoup:1.7.2\" }`",
"properties":{
"coordinates":{
"description":"Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\"."
},
"exclusions":{
"description":"List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.",
"items":{
"description":""
}
},
"repo":{
"description":"Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched."
}
}
},
"pypi":{
"description":"Specification of a PyPi library to be installed. For example:\n`{ \"package\": \"simplejson\" }`",
"properties":{
"package":{
"description":"The name of the pypi package to install. An optional exact version specification is also\nsupported. Examples: \"simplejson\" and \"simplejson==3.8.0\"."
},
"repo":{
"description":"The repository where the package can be found. If not specified, the default pip index is\nused."
}
}
},
"whl":{
"description":"URI of the wheel to be installed.\nFor example: `{ \"whl\": \"dbfs:/my/whl\" }` or `{ \"whl\": \"s3://my-bucket/whl\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
}
}
}
},
"max_retries":{
"description":"An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with the `FAILED` result_state or `INTERNAL_ERROR` `life_cycle_state`. The value -1 means to retry indefinitely and the value 0 means to never retry. The default behavior is to never retry."
},
"min_retry_interval_millis":{
"description":"An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried."
},
"new_cluster":{
"description":"If new_cluster, a description of a cluster that is created for each task.",
"properties":{
"autoscale":{
"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.",
"properties":{
"max_workers":{
"description":"The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`."
},
"min_workers":{
"description":"The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation."
}
}
},
"autotermination_minutes":{
"description":"Automatically terminates the cluster after it is inactive for this time in minutes. If not set,\nthis cluster will not be automatically terminated. If specified, the threshold must be between\n10 and 10000 minutes.\nUsers can also set this value to 0 to explicitly disable automatic termination."
},
"aws_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"ebs_volume_count":{
"description":"The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden."
},
"ebs_volume_iops":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_size":{
"description":"The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096."
},
"ebs_volume_throughput":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_type":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"instance_profile_arn":{
"description":"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.\n\nIf this field is ommitted, we will pull in the default from the conf if it exists."
},
"spot_bid_price_percent":{
"description":"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.\n\nThe default value and documentation here should be kept consistent with\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent."
},
"zone_id":{
"description":"Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\nSee [[AutoAZHelper.scala]] for more details.\nThe list of available zones as well as the default value can be found by using the\n`List Zones`_ method."
}
}
},
"azure_attributes":{
"description":"Attributes related to clusters running on Microsoft Azure.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"log_analytics_info":{
"description":"Defines values necessary to configure and run Azure Log Analytics agent",
"properties":{
"log_analytics_primary_key":{
"description":"\u003cneeds content added\u003e"
},
"log_analytics_workspace_id":{
"description":"\u003cneeds content added\u003e"
}
}
},
"spot_bid_max_price":{
"description":"The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1."
}
}
},
"cluster_log_conf":{
"description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.",
"properties":{
"dbfs":{
"description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`",
"properties":{
"destination":{
"description":"dbfs destination, e.g. `dbfs:/my/path`"
}
}
},
"s3":{
"description":"destination and either region or endpoint should also be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.",
"properties":{
"canned_acl":{
"description":"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs."
},
"destination":{
"description":"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs."
},
"enable_encryption":{
"description":"(Optional) Flag to enable server side encryption, `false` by default."
},
"encryption_type":{
"description":"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`."
},
"endpoint":{
"description":"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used."
},
"kms_key":{
"description":"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`."
},
"region":{
"description":"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used."
}
}
}
}
},
"cluster_name":{
"description":"Cluster name requested by the user. This doesn't have to be unique.\nIf not specified at creation, the cluster name will be an empty string.\n"
},
"cluster_source":{
"description":""
},
"custom_tags":{
"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags",
"additionalproperties":{
"description":""
}
},
"driver_instance_pool_id":{
"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."
},
"driver_node_type_id":{
"description":"The node type of the Spark driver. Note that this field is optional;\nif unset, the driver node type will be set as the same value\nas `node_type_id` defined above.\n"
},
"enable_elastic_disk":{
"description":"Autoscaling Local Storage: when enabled, this cluster will dynamically acquire additional disk\nspace when its Spark workers are running low on disk space. This feature requires specific AWS\npermissions to function correctly - refer to the User Guide for more details."
},
"enable_local_disk_encryption":{
"description":"Whether to enable LUKS on cluster VMs' local disks"
},
"gcp_attributes":{
"description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"boot_disk_size":{
"description":"boot disk size in GB"
},
"google_service_account":{
"description":"If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator."
}
}
},
"instance_pool_id":{
"description":"The optional ID of the instance pool to which the cluster belongs."
},
"node_type_id":{
"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"
},
"num_workers":{
"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."
},
"policy_id":{
"description":"The ID of the cluster policy used to create the cluster if applicable."
},
"runtime_engine":{
"description":""
},
"spark_conf":{
"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nUsers can also pass in a string of extra JVM options to the driver and the executors via\n`spark.driver.extraJavaOptions` and `spark.executor.extraJavaOptions` respectively.\n",
"additionalproperties":{
"description":""
}
},
"spark_env_vars":{
"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`",
"additionalproperties":{
"description":""
}
},
"spark_version":{
"description":"The Spark version of the cluster, e.g. `3.3.x-scala2.11`.\nA list of available Spark versions can be retrieved by using\nthe :method:clusters/sparkVersions API call.\n"
},
"ssh_public_keys":{
"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.",
"items":{
"description":""
}
},
"workload_type":{
"description":"",
"properties":{
"clients":{
"description":" defined what type of clients can use the cluster. E.g. Notebooks, Jobs",
"properties":{
"jobs":{
"description":"With jobs set, the cluster can be used for jobs"
},
"notebooks":{
"description":"With notebooks set, this cluster can be used for notebooks"
}
}
}
}
}
}
},
"notebook_task":{
"description":"If notebook_task, indicates that this task must run a notebook. This field may not be specified in conjunction with spark_jar_task.",
"properties":{
"base_parameters":{
"description":"Base parameters to be used for each run of this job. If the run is initiated by a call to\n:method:jobs/runNow with parameters specified, the two parameters maps are merged. If the same key is specified in\n`base_parameters` and in `run-now`, the value from `run-now` is used.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n\nIf the notebook takes a parameter that is not specified in the job’s `base_parameters` or the `run-now` override parameters,\nthe default value from the notebook is used.\n\nRetrieve these parameters in a notebook using [dbutils.widgets.get](https://docs.databricks.com/dev-tools/databricks-utils.html#dbutils-widgets).\n",
"additionalproperties":{
"description":""
}
},
"notebook_path":{
"description":"The path of the notebook to be run in the Databricks workspace or remote repository.\nFor notebooks stored in the Databricks workspace, the path must be absolute and begin with a slash.\nFor notebooks stored in a remote repository, the path must be relative. This field is required.\n"
},
"source":{
"description":"This describes an enum"
}
}
},
"pipeline_task":{
"description":"If pipeline_task, indicates that this task must execute a Pipeline.",
"properties":{
"full_refresh":{
"description":"If true, a full refresh will be triggered on the delta live table."
},
"pipeline_id":{
"description":"The full name of the pipeline task to execute."
}
}
},
"python_wheel_task":{
"description":"If python_wheel_task, indicates that this job must execute a PythonWheel.",
"properties":{
"entry_point":{
"description":"Named entry point to use, if it does not exist in the metadata of the package it executes the function from the package directly using `$packageName.$entryPoint()`"
},
"named_parameters":{
"description":"Command-line parameters passed to Python wheel task in the form of `[\"--name=task\", \"--data=dbfs:/path/to/data.json\"]`. Leave it empty if `parameters` is not null.",
"additionalproperties":{
"description":""
}
},
"package_name":{
"description":"Name of the package to execute"
},
"parameters":{
"description":"Command-line parameters passed to Python wheel task. Leave it empty if `named_parameters` is not null.",
"items":{
"description":""
}
}
}
},
"retry_on_timeout":{
"description":"An optional policy to specify whether to retry a task when it times out. The default behavior is to not retry on timeout."
},
"spark_jar_task":{
"description":"If spark_jar_task, indicates that this task must run a JAR.",
"properties":{
"jar_uri":{
"description":"Deprecated since 04/2016\\\\. Provide a `jar` through the `libraries` field instead. For an example, see :method:jobs/create.\n"
},
"main_class_name":{
"description":"The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library.\n\nThe code must use `SparkContext.getOrCreate` to obtain a Spark context; otherwise, runs of the job fail."
},
"parameters":{
"description":"Parameters passed to the main method.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n",
"items":{
"description":""
}
}
}
},
"spark_python_task":{
"description":"If spark_python_task, indicates that this task must run a Python file.",
"properties":{
"parameters":{
"description":"Command line parameters passed to the Python file.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n",
"items":{
"description":""
}
},
"python_file":{
"description":""
}
}
},
"spark_submit_task":{
"description":"If spark_submit_task, indicates that this task must be launched by the spark submit script. This task can run only on new clusters.",
"properties":{
"parameters":{
"description":"Command-line parameters passed to spark submit.\n\nUse [Task parameter variables](https://docs.databricks.com/jobs.html#parameter-variables) to set parameters containing information about job runs.\n",
"items":{
"description":""
}
}
}
},
"sql_task":{
"description":"If sql_task, indicates that this job must execute a SQL task.",
"properties":{
"alert":{
"description":"If alert, indicates that this job must refresh a SQL alert.",
"properties":{
"alert_id":{
"description":"The canonical identifier of the SQL alert."
},
"pause_subscriptions":{
"description":"If true, the alert notifications are not sent to subscribers."
},
"subscriptions":{
"description":"If specified, alert notifications are sent to subscribers.",
"items":{
"description":"",
"properties":{
"destination_id":{
"description":"The canonical identifier of the destination to receive email notification."
},
"user_name":{
"description":"The user name to receive the subscription email."
}
}
}
}
}
},
"dashboard":{
"description":"If dashboard, indicates that this job must refresh a SQL dashboard.",
"properties":{
"custom_subject":{
"description":"Subject of the email sent to subscribers of this task."
},
"dashboard_id":{
"description":"The canonical identifier of the SQL dashboard."
},
"pause_subscriptions":{
"description":"If true, the dashboard snapshot is not taken, and emails are not sent to subscribers."
},
"subscriptions":{
"description":"If specified, dashboard snapshots are sent to subscriptions.",
"items":{
"description":"",
"properties":{
"destination_id":{
"description":"The canonical identifier of the destination to receive email notification."
},
"user_name":{
"description":"The user name to receive the subscription email."
}
}
}
}
}
},
"parameters":{
"description":"Parameters to be used for each run of this job. The SQL alert task does not support custom parameters.",
"additionalproperties":{
"description":""
}
},
"query":{
"description":"If query, indicates that this job must execute a SQL query.",
"properties":{
"query_id":{
"description":"The canonical identifier of the SQL query."
}
}
},
"warehouse_id":{
"description":"The canonical identifier of the SQL warehouse. Only serverless and pro SQL warehouses are supported."
}
}
},
"task_key":{
"description":"A unique name for the task. This field is used to refer to this task from other tasks.\nThis field is required and must be unique within its parent job.\nOn Update or Reset, this field is used to reference the tasks to be updated or reset.\nThe maximum length is 100 characters."
},
"timeout_seconds":{
"description":"An optional timeout applied to each run of this job task. The default behavior is to have no timeout."
}
}
}
},
"timeout_seconds":{
"description":"An optional timeout applied to each run of this job. The default behavior is to have no timeout."
"description":"A collection of system notification IDs to notify when the run begins or completes. The default behavior is to not send any system notifications.",
"properties":{
"on_failure":{
"description":"An optional list of system notification IDs to call when the run fails. A maximum of 3 destinations can be specified for the `on_failure` property.",
"items":{
"description":"",
"properties":{
"id":{
"description":""
}
}
}
},
"on_start":{
"description":"An optional list of system notification IDs to call when the run starts. A maximum of 3 destinations can be specified for the `on_start` property.",
"items":{
"description":"",
"properties":{
"id":{
"description":""
}
}
}
},
"on_success":{
"description":"An optional list of system notification IDs to call when the run completes successfully. A maximum of 3 destinations can be specified for the `on_success` property.",
"description":"Catalog in UC to add tables to. If target is specified, tables in this pipeline will be\npublished to a \"target\" schema inside catalog (i.e. \u003ccatalog\u003e.\u003ctarget\u003e.\u003ctable\u003e)."
},
"channel":{
"description":"DLT Release Channel that specifies which version to use."
},
"clusters":{
"description":"Cluster settings for this pipeline deployment.",
"items":{
"description":"",
"properties":{
"apply_policy_default_values":{
"description":"Note: This field won't be persisted. Only API users will check this field."
},
"autoscale":{
"description":"Parameters needed in order to automatically scale clusters up and down based on load.\nNote: autoscaling works best with DB runtime versions 3.0 or later.",
"properties":{
"max_workers":{
"description":"The maximum number of workers to which the cluster can scale up when overloaded.\nNote that `max_workers` must be strictly greater than `min_workers`."
},
"min_workers":{
"description":"The minimum number of workers to which the cluster can scale down when underutilized.\nIt is also the initial number of workers the cluster will have after creation."
}
}
},
"aws_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"ebs_volume_count":{
"description":"The number of volumes launched for each instance. Users can choose up to 10 volumes.\nThis feature is only enabled for supported node types. Legacy node types cannot specify\ncustom EBS volumes.\nFor node types with no instance store, at least one EBS volume needs to be specified;\notherwise, cluster creation will fail.\n\nThese EBS volumes will be mounted at `/ebs0`, `/ebs1`, and etc.\nInstance store volumes will be mounted at `/local_disk0`, `/local_disk1`, and etc.\n\nIf EBS volumes are attached, Databricks will configure Spark to use only the EBS volumes for\nscratch storage because heterogenously sized scratch devices can lead to inefficient disk\nutilization. If no EBS volumes are attached, Databricks will configure Spark to use instance\nstore volumes.\n\nPlease note that if EBS volumes are specified, then the Spark configuration `spark.local.dir`\nwill be overridden."
},
"ebs_volume_iops":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_size":{
"description":"The size of each EBS volume (in GiB) launched for each instance. For general purpose\nSSD, this value must be within the range 100 - 4096. For throughput optimized HDD,\nthis value must be within the range 500 - 4096."
},
"ebs_volume_throughput":{
"description":"\u003cneeds content added\u003e"
},
"ebs_volume_type":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nIf this value is greater than 0, the cluster driver node in particular will be placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"instance_profile_arn":{
"description":"Nodes for this cluster will only be placed on AWS instances with this instance profile. If\nommitted, nodes will be placed on instances without an IAM instance profile. The instance\nprofile must have previously been added to the Databricks environment by an account\nadministrator.\n\nThis feature may only be available to certain customer plans.\n\nIf this field is ommitted, we will pull in the default from the conf if it exists."
},
"spot_bid_price_percent":{
"description":"The bid price for AWS spot instances, as a percentage of the corresponding instance type's\non-demand price.\nFor example, if this field is set to 50, and the cluster needs a new `r3.xlarge` spot\ninstance, then the bid price is half of the price of\non-demand `r3.xlarge` instances. Similarly, if this field is set to 200, the bid price is twice\nthe price of on-demand `r3.xlarge` instances. If not specified, the default value is 100.\nWhen spot instances are requested for this cluster, only spot instances whose bid price\npercentage matches this field will be considered.\nNote that, for safety, we enforce this field to be no more than 10000.\n\nThe default value and documentation here should be kept consistent with\nCommonConf.defaultSpotBidPricePercent and CommonConf.maxSpotBidPricePercent."
},
"zone_id":{
"description":"Identifier for the availability zone/datacenter in which the cluster resides.\nThis string will be of a form like \"us-west-2a\". The provided availability\nzone must be in the same region as the Databricks deployment. For example, \"us-west-2a\"\nis not a valid zone id if the Databricks deployment resides in the \"us-east-1\" region.\nThis is an optional field at cluster creation, and if not specified, a default zone will be used.\nIf the zone specified is \"auto\", will try to place cluster in a zone with high availability,\nand will retry placement in a different AZ if there is not enough capacity.\nSee [[AutoAZHelper.scala]] for more details.\nThe list of available zones as well as the default value can be found by using the\n`List Zones`_ method."
}
}
},
"azure_attributes":{
"description":"Attributes related to clusters running on Amazon Web Services.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"first_on_demand":{
"description":"The first `first_on_demand` nodes of the cluster will be placed on on-demand instances.\nThis value should be greater than 0, to make sure the cluster driver node is placed on an\non-demand instance. If this value is greater than or equal to the current cluster size, all\nnodes will be placed on on-demand instances. If this value is less than the current cluster\nsize, `first_on_demand` nodes will be placed on on-demand instances and the remainder will\nbe placed on `availability` instances. Note that this value does not affect\ncluster size and cannot currently be mutated over the lifetime of a cluster."
},
"log_analytics_info":{
"description":"Defines values necessary to configure and run Azure Log Analytics agent",
"properties":{
"log_analytics_primary_key":{
"description":"\u003cneeds content added\u003e"
},
"log_analytics_workspace_id":{
"description":"\u003cneeds content added\u003e"
}
}
},
"spot_bid_max_price":{
"description":"The max bid price to be used for Azure spot instances.\nThe Max price for the bid cannot be higher than the on-demand price of the instance.\nIf not specified, the default value is -1, which specifies that the instance cannot be evicted\non the basis of price, and only on the basis of availability. Further, the value should \u003e 0 or -1."
}
}
},
"cluster_log_conf":{
"description":"The configuration for delivering spark logs to a long-term storage destination.\nTwo kinds of destinations (dbfs and s3) are supported. Only one destination can be specified\nfor one cluster. If the conf is given, the logs will be delivered to the destination every\n`5 mins`. The destination of driver logs is `$destination/$clusterId/driver`, while\nthe destination of executor logs is `$destination/$clusterId/executor`.",
"properties":{
"dbfs":{
"description":"destination needs to be provided. e.g.\n`{ \"dbfs\" : { \"destination\" : \"dbfs:/home/cluster_log\" } }`",
"properties":{
"destination":{
"description":"dbfs destination, e.g. `dbfs:/my/path`"
}
}
},
"s3":{
"description":"destination and either region or endpoint should also be provided. e.g.\n`{ \"s3\": { \"destination\" : \"s3://cluster_log_bucket/prefix\", \"region\" : \"us-west-2\" } }`\nCluster iam role is used to access s3, please make sure the cluster iam role in\n`instance_profile_arn` has permission to write data to the s3 destination.",
"properties":{
"canned_acl":{
"description":"(Optional) Set canned access control list for the logs, e.g. `bucket-owner-full-control`.\nIf `canned_cal` is set, please make sure the cluster iam role has `s3:PutObjectAcl` permission on\nthe destination bucket and prefix. The full list of possible canned acl can be found at\nhttp://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl.\nPlease also note that by default only the object owner gets full controls. If you are using cross account\nrole for writing data, you may want to set `bucket-owner-full-control` to make bucket owner able to\nread the logs."
},
"destination":{
"description":"S3 destination, e.g. `s3://my-bucket/some-prefix` Note that logs will be delivered using\ncluster iam role, please make sure you set cluster iam role and the role has write access to the\ndestination. Please also note that you cannot use AWS keys to deliver logs."
},
"enable_encryption":{
"description":"(Optional) Flag to enable server side encryption, `false` by default."
},
"encryption_type":{
"description":"(Optional) The encryption type, it could be `sse-s3` or `sse-kms`. It will be used only when\nencryption is enabled and the default type is `sse-s3`."
},
"endpoint":{
"description":"S3 endpoint, e.g. `https://s3-us-west-2.amazonaws.com`. Either region or endpoint needs to be set.\nIf both are set, endpoint will be used."
},
"kms_key":{
"description":"(Optional) Kms key which will be used if encryption is enabled and encryption type is set to `sse-kms`."
},
"region":{
"description":"S3 region, e.g. `us-west-2`. Either region or endpoint needs to be set. If both are set,\nendpoint will be used."
}
}
}
}
},
"custom_tags":{
"description":"Additional tags for cluster resources. Databricks will tag all cluster resources (e.g., AWS\ninstances and EBS volumes) with these tags in addition to `default_tags`. Notes:\n\n- Currently, Databricks allows at most 45 custom tags\n\n- Clusters can only reuse cloud resources if the resources' tags are a subset of the cluster tags",
"additionalproperties":{
"description":""
}
},
"driver_instance_pool_id":{
"description":"The optional ID of the instance pool for the driver of the cluster belongs.\nThe pool cluster uses the instance pool with id (instance_pool_id) if the driver pool is not\nassigned."
},
"driver_node_type_id":{
"description":"The node type of the Spark driver.\nNote that this field is optional; if unset, the driver node type will be set as the same value\nas `node_type_id` defined above."
},
"gcp_attributes":{
"description":"Attributes related to clusters running on Google Cloud Platform.\nIf not specified at cluster creation, a set of default values will be used.",
"properties":{
"availability":{
"description":""
},
"boot_disk_size":{
"description":"boot disk size in GB"
},
"google_service_account":{
"description":"If provided, the cluster will impersonate the google service account when accessing\ngcloud services (like GCS). The google service account\nmust have previously been added to the Databricks environment by an account\nadministrator."
}
}
},
"instance_pool_id":{
"description":"The optional ID of the instance pool to which the cluster belongs."
},
"label":{
"description":"Cluster label"
},
"node_type_id":{
"description":"This field encodes, through a single value, the resources available to each of\nthe Spark nodes in this cluster. For example, the Spark nodes can be provisioned\nand optimized for memory or compute intensive workloads. A list of available node\ntypes can be retrieved by using the :method:clusters/listNodeTypes API call.\n"
},
"num_workers":{
"description":"Number of worker nodes that this cluster should have. A cluster has one Spark Driver\nand `num_workers` Executors for a total of `num_workers` + 1 Spark nodes.\n\nNote: When reading the properties of a cluster, this field reflects the desired number\nof workers rather than the actual current number of workers. For instance, if a cluster\nis resized from 5 to 10 workers, this field will immediately be updated to reflect\nthe target size of 10 workers, whereas the workers listed in `spark_info` will gradually\nincrease from 5 to 10 as the new nodes are provisioned."
},
"policy_id":{
"description":"The ID of the cluster policy used to create the cluster if applicable."
},
"spark_conf":{
"description":"An object containing a set of optional, user-specified Spark configuration key-value pairs.\nSee :method:clusters/create for more details.\n",
"additionalproperties":{
"description":""
}
},
"spark_env_vars":{
"description":"An object containing a set of optional, user-specified environment variable key-value pairs.\nPlease note that key-value pair of the form (X,Y) will be exported as is (i.e.,\n`export X='Y'`) while launching the driver and workers.\n\nIn order to specify an additional set of `SPARK_DAEMON_JAVA_OPTS`, we recommend appending\nthem to `$SPARK_DAEMON_JAVA_OPTS` as shown in the example below. This ensures that all\ndefault databricks managed environmental variables are included as well.\n\nExample Spark environment variables:\n`{\"SPARK_WORKER_MEMORY\": \"28000m\", \"SPARK_LOCAL_DIRS\": \"/local_disk0\"}` or\n`{\"SPARK_DAEMON_JAVA_OPTS\": \"$SPARK_DAEMON_JAVA_OPTS -Dspark.shuffle.service.enabled=true\"}`",
"additionalproperties":{
"description":""
}
},
"ssh_public_keys":{
"description":"SSH public key contents that will be added to each Spark node in this cluster. The\ncorresponding private keys can be used to login with the user name `ubuntu` on port `2200`.\nUp to 10 keys can be specified.",
"items":{
"description":""
}
}
}
}
},
"configuration":{
"description":"String-String configuration for this pipeline execution.",
"additionalproperties":{
"description":""
}
},
"continuous":{
"description":"Whether the pipeline is continuous or triggered. This replaces `trigger`."
},
"development":{
"description":"Whether the pipeline is in Development mode. Defaults to false."
},
"edition":{
"description":"Pipeline product edition."
},
"filters":{
"description":"Filters on which Pipeline packages to include in the deployed graph.",
"properties":{
"exclude":{
"description":"Paths to exclude.",
"items":{
"description":""
}
},
"include":{
"description":"Paths to include.",
"items":{
"description":""
}
}
}
},
"id":{
"description":"Unique identifier for this pipeline."
},
"libraries":{
"description":"Libraries or code needed by this deployment.",
"description":"URI of the jar to be installed. Currently only DBFS and S3 URIs are supported.\nFor example: `{ \"jar\": \"dbfs:/mnt/databricks/library.jar\" }` or\n`{ \"jar\": \"s3://my-bucket/library.jar\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
},
"maven":{
"description":"Specification of a maven library to be installed. For example:\n`{ \"coordinates\": \"org.jsoup:jsoup:1.7.2\" }`",
"properties":{
"coordinates":{
"description":"Gradle-style maven coordinates. For example: \"org.jsoup:jsoup:1.7.2\"."
},
"exclusions":{
"description":"List of dependences to exclude. For example: `[\"slf4j:slf4j\", \"*:hadoop-client\"]`.\n\nMaven dependency exclusions:\nhttps://maven.apache.org/guides/introduction/introduction-to-optional-and-excludes-dependencies.html.",
"items":{
"description":""
}
},
"repo":{
"description":"Maven repo to install the Maven package from. If omitted, both Maven Central Repository\nand Spark Packages are searched."
}
}
},
"notebook":{
"description":"The path to a notebook that defines a pipeline and is stored in the Databricks workspace.\nFor example: `{ \"notebook\" : { \"path\" : \"/my-pipeline-notebook-path\" } }`.\nCurrently, only Scala notebooks are supported, and pipelines must be defined in a package\ncell.",
"properties":{
"path":{
"description":"The absolute path of the notebook."
}
}
},
"whl":{
"description":"URI of the wheel to be installed.\nFor example: `{ \"whl\": \"dbfs:/my/whl\" }` or `{ \"whl\": \"s3://my-bucket/whl\" }`.\nIf S3 is used, please make sure the cluster has read access on the library. You may need to\nlaunch the cluster with an IAM role to access the S3 URI."
}
}
}
},
"name":{
"description":"Friendly identifier for this pipeline."
"description":"The base location for synchronizing files, artifacts and state. Defaults to `/Users/jane@doe.com/.bundle/${bundle.name}/${bundle.environment}`"
