--- title: "POST /v1/{+parent}/workflowTemplates" method: POST path: "/v1/{+parent}/workflowTemplates" tags: ["projects"] --- # POST /v1/{+parent}/workflowTemplates `POST /v1/{+parent}/workflowTemplates` Creates new workflow template. ## Path parameters - `parent` string, required ## Request body - WorkflowTemplate — A Dataproc workflow template resource. - `createTime` string, google-datetime — Output only. The time template was created. - `id` string - `version` integer — Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. - `encryptionConfig` GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig — Encryption settings for encrypting workflow template job arguments. - `kmsKey` string — Optional. The Cloud KMS key name to use for encrypting workflow template job arguments.When this this key is provided, the following workflow template job arguments (https://cloud.google.com/dataproc/docs/concepts/workflows/use-workflows#adding_jobs_to_a_template), if present, are CMEK encrypted (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_workflow_template_data): FlinkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/FlinkJob) HadoopJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/HadoopJob) SparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkJob) SparkRJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkRJob) PySparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/PySparkJob) SparkSqlJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkSqlJob) scriptVariables and queryList.queries HiveJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/HiveJob) scriptVariables and queryList.queries PigJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PigJob) scriptVariables and queryList.queries PrestoJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PrestoJob) scriptVariables and queryList.queries - `labels` object — Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. - `updateTime` string, google-datetime — Output only. The time template was last updated. - `placement` WorkflowTemplatePlacement — Specifies workflow execution target.Either managed_cluster or cluster_selector is required. - `clusterSelector` ClusterSelector — A selector that chooses target cluster for jobs based on metadata. - `zone` string — Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used. - `clusterLabels` object — Required. The cluster labels. Cluster must have all labels to match. - `managedCluster` ManagedCluster — Cluster that is managed by the workflow. - `config` ClusterConfig — The cluster config. - `softwareConfig` SoftwareConfig — Specifies the selection and config of software inside the cluster. - `properties` object — Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). - `imageVersion` string — Optional. The version of software inside the cluster. It must be one of the supported Image Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported-dataproc-image-versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version. - `optionalComponents` string[] — Optional. The set of components to activate on the cluster. - `dataprocMetricConfig` DataprocMetricConfig — Metric config. - `metrics` Metric[] — Required. Metrics sources to enable. - `metricOverrides` string[] — Optional. Specify one or more Custom metrics (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics) to collect for the metric course (for the SPARK metric source (any Spark metric (https://spark.apache.org/docs/latest/monitoring.html#metrics) can be specified).Provide metrics in the following format: METRIC_SOURCE: INSTANCE:GROUP:METRIC Use camelcase as appropriate.Examples: yarn:ResourceManager:QueueMetrics:AppsCompleted spark:driver:DAGScheduler:job.allJobs sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed hiveserver2:JVM:Memory:NonHeapMemoryUsage.used Notes: Only the specified overridden metrics are collected for the metric source. For example, if one or more spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is unaffected. For example, if both SPARK and YARN metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected. - `metricSource` 'METRIC_SOURCE_UNSPECIFIED' | 'MONITORING_AGENT_DEFAULTS' | 'HDFS' | 'SPARK' | 'YARN' | 'SPARK_HISTORY_SERVER' | 'HIVESERVER2' | 'HIVEMETASTORE' | 'FLINK' — Required. A standard set of metrics is collected unless metricOverrides are specified for the metric source (see Custom metrics (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics) for more information). - `encryptionConfig` EncryptionConfig — Encryption settings for the cluster. - `gcePdKmsKeyName` string — Optional. The Cloud KMS key resource name to use for persistent disk encryption for all instances in the cluster. See Use CMEK with cluster data (https://cloud.google.com//dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_cluster_data) for more information. - `kmsKey` string — Optional. The Cloud KMS key resource name to use for cluster persistent disk and job argument encryption. See Use CMEK with cluster data (https://cloud.google.com//dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_cluster_data) for more information.When this key resource name is provided, the following job arguments of the following job types submitted to the cluster are encrypted using CMEK: FlinkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/FlinkJob) HadoopJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/HadoopJob) SparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkJob) SparkRJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkRJob) PySparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/PySparkJob) SparkSqlJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkSqlJob) scriptVariables and queryList.queries HiveJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/HiveJob) scriptVariables and queryList.queries PigJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PigJob) scriptVariables and queryList.queries PrestoJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PrestoJob) scriptVariables and queryList.queries - `engine` 'ENGINE_UNSPECIFIED' | 'DEFAULT' | 'LIGHTNING' — Optional. The cluster engine. - `auxiliaryNodeGroups` AuxiliaryNodeGroup[] — Optional. The node group settings. - `nodeGroup` NodeGroup — Node Group. The NodeGroup resource is not related to the NodeGroupAffinity resource. - `roles` string[] — Required. Node group roles. - `name` string — The Node group resource name (https://aip.dev/122). - `labels` object — Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labels. - `nodeGroupConfig` InstanceGroupConfig — The config settings for Compute Engine resources in an instance group, such as a master or worker group. - … - `nodeGroupId` string — Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters. - `gkeClusterConfig` GkeClusterConfig — The cluster's GKE config. - `nodePoolTarget` GkeNodePoolTarget[] — Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings. - `nodePool` string — Required. The target GKE node pool. Format: 'projects/{project}/locations/{location}/clusters/{cluster}/nodePools/{node_pool}' - `roles` string[] — Required. The roles associated with the GKE node pool. - `nodePoolConfig` GkeNodePoolConfig — The configuration of a GKE node pool used by a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/concepts/jobs/dataproc-gke#create-a-dataproc-on-gke-cluster). - … - `gkeClusterTarget` string — Optional. A target GKE cluster to deploy to. It must be in the same project and region as the Dataproc cluster (the GKE cluster can be zonal or regional). Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}' - `namespacedGkeDeploymentTarget` NamespacedGkeDeploymentTarget — Deprecated. Used only for the deprecated beta. A full, namespace-isolated deployment target for an existing GKE cluster. - `targetGkeCluster` string — Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}' - `clusterNamespace` string — Optional. A namespace within the GKE cluster to deploy into. - `clusterType` 'CLUSTER_TYPE_UNSPECIFIED' | 'STANDARD' | 'SINGLE_NODE' | 'ZERO_SCALE' — Optional. The type of the cluster. - `workerConfig` InstanceGroupConfig — The config settings for Compute Engine resources in an instance group, such as a master or worker group. - `instanceNames` string[] — Output only. The list of instance names, derived from cluster_name, num_instances, and the instance group. - `preemptibility` 'PREEMPTIBILITY_UNSPECIFIED' | 'NON_PREEMPTIBLE' | 'PREEMPTIBLE' | 'SPOT' — Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE. - `minCpuPlatform` string — Optional. Specifies the minimum cpu platform for the Instance Group. See Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu). - `startupConfig` StartupConfig — Configuration to handle the startup of instances during cluster create and update process. - `requiredRegistrationFraction` number, double — Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). - `managedGroupConfig` ManagedGroupConfig — Specifies the resources used to actively manage an instance group. - `instanceGroupManagerUri` string — Output only. The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm. - `instanceTemplateName` string — Output only. The name of the Instance Template used for the Managed Instance Group. - `instanceGroupManagerName` string — Output only. The name of the Instance Group Manager for this group. - `minNumInstances` integer — Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted. - `instanceFlexibilityPolicy` InstanceFlexibilityPolicy — Instance flexibility Policy allowing a mixture of VM shapes and provisioning models. - `instanceMachineTypes` object — Output only. A map of instance short name to machine type. The key is the short name of the Compute Engine instance, and the value is the full machine-type name (e.g., 'n1-standard-16'). See Machine types for more information on valid machine type strings. - `instanceSelectionList` InstanceSelection[] — Optional. List of instance selection options that the group will use when creating new VMs. - … - `instanceSelectionResults` InstanceSelectionResult[] — Output only. A list of instance selection results in the group. - … - `provisioningModelMix` ProvisioningModelMix — Defines how to create VMs with a mixture of provisioning models. - … - `instanceReferences` InstanceReference[] — Output only. List of references to Compute Engine instances. - `publicKey` string — The public RSA key used for sharing data with this instance. - `publicEciesKey` string — The public ECIES key used for sharing data with this instance. - `instanceId` string — The unique identifier of the Compute Engine instance. - `instanceName` string — The user-friendly name of the Compute Engine instance. - `imageUri` string — Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. The service will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default. - `accelerators` AcceleratorConfig[] — Optional. The Compute Engine accelerator configuration for these instances. - `acceleratorTypeUri` string — Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 nvidia-tesla-t4Auto Zone Exception: If you are using Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement), you must use the short name of the accelerator type resource, for example, nvidia-tesla-t4. - `acceleratorCount` integer — The number of the accelerator cards of this type exposed to this instance. - `numInstances` integer — Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1. - `diskConfig` DiskConfig — Specifies the config of boot disk and attached disk options for a group of VM instances. - `numLocalSsds` integer — Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected. - `bootDiskProvisionedIops` string, int64 — Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. - `bootDiskType` string — Optional. Type of the boot disk (default is pd-standard). Valid values: pd-balanced (Persistent Disk Balanced Solid State Drive), pd-ssd (Persistent Disk Solid State Drive), or pd-standard (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types). - `bootDiskSizeGb` integer — Optional. Size in GB of the boot disk (default is 500GB). - `localSsdInterface` string — Optional. Interface type of local SSDs (default is scsi). Valid values: scsi (Small Computer System Interface), nvme (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance). - `bootDiskProvisionedThroughput` string, int64 — Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced. - `attachedDiskConfigs` AttachedDiskConfig[] — Optional. A list of attached disk configs for a group of VM instances. - … - `isPreemptible` boolean — Output only. Specifies that this instance group contains preemptible instances. - `machineTypeUri` string — Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement), you must use the short name of the machine type resource, for example, n1-standard-2. - `endpointConfig` EndpointConfig — Endpoint config for this cluster - `httpPorts` object — Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true. - `enableHttpPortAccess` boolean — Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false. - `tempBucket` string — Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, the service will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. - `autoscalingConfig` AutoscalingConfig — Autoscaling Policy config associated with the cluster. - `policyUri` string — Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and region. - `lifecycleConfig` LifecycleConfig — Specifies the cluster auto-delete schedule configuration. - `autoDeleteTtl` string, google-duration — Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). - `idleStartTime` string, google-datetime — Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). - `idleStopTtl` string, google-duration — Optional. The duration to keep the cluster started while idling (when no jobs are running). Passing this threshold will cause the cluster to be stopped. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). - `autoStopTtl` string, google-duration — Optional. The lifetime duration of the cluster. The cluster will be auto-stopped at the end of this period, calculated from the time of submission of the create or update cluster request. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). - `autoDeleteTime` string, google-datetime — Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). - `idleDeleteTtl` string, google-duration — Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). - `autoStopTime` string, google-datetime — Optional. The time when cluster will be auto-stopped (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)). - `clusterTier` 'CLUSTER_TIER_UNSPECIFIED' | 'CLUSTER_TIER_STANDARD' | 'CLUSTER_TIER_PREMIUM' — Optional. The cluster tier. - `secondaryWorkerConfig` InstanceGroupConfig — The config settings for Compute Engine resources in an instance group, such as a master or worker group. - `instanceNames` string[] — Output only. The list of instance names, derived from cluster_name, num_instances, and the instance group. - `preemptibility` 'PREEMPTIBILITY_UNSPECIFIED' | 'NON_PREEMPTIBLE' | 'PREEMPTIBLE' | 'SPOT' — Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE. - `minCpuPlatform` string — Optional. Specifies the minimum cpu platform for the Instance Group. See Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu). - `startupConfig` StartupConfig — Configuration to handle the startup of instances during cluster create and update process. - `requiredRegistrationFraction` number, double — Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). - `managedGroupConfig` ManagedGroupConfig — Specifies the resources used to actively manage an instance group. - `instanceGroupManagerUri` string — Output only. The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm. - `instanceTemplateName` string — Output only. The name of the Instance Template used for the Managed Instance Group. - `instanceGroupManagerName` string — Output only. The name of the Instance Group Manager for this group. - `minNumInstances` integer — Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted. - `instanceFlexibilityPolicy` InstanceFlexibilityPolicy — Instance flexibility Policy allowing a mixture of VM shapes and provisioning models. - `instanceMachineTypes` object — Output only. A map of instance short name to machine type. The key is the short name of the Compute Engine instance, and the value is the full machine-type name (e.g., 'n1-standard-16'). See Machine types for more information on valid machine type strings. - `instanceSelectionList` InstanceSelection[] — Optional. List of instance selection options that the group will use when creating new VMs. - … - `instanceSelectionResults` InstanceSelectionResult[] — Output only. A list of instance selection results in the group. - … - `provisioningModelMix` ProvisioningModelMix — Defines how to create VMs with a mixture of provisioning models. - … - `instanceReferences` InstanceReference[] — Output only. List of references to Compute Engine instances. - `publicKey` string — The public RSA key used for sharing data with this instance. - `publicEciesKey` string — The public ECIES key used for sharing data with this instance. - `instanceId` string — The unique identifier of the Compute Engine instance. - `instanceName` string — The user-friendly name of the Compute Engine instance. - `imageUri` string — Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. The service will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default. - `accelerators` AcceleratorConfig[] — Optional. The Compute Engine accelerator configuration for these instances. - `acceleratorTypeUri` string — Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 nvidia-tesla-t4Auto Zone Exception: If you are using Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement), you must use the short name of the accelerator type resource, for example, nvidia-tesla-t4. - `acceleratorCount` integer — The number of the accelerator cards of this type exposed to this instance. - `numInstances` integer — Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1. - `diskConfig` DiskConfig — Specifies the config of boot disk and attached disk options for a group of VM instances. - `numLocalSsds` integer — Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected. - `bootDiskProvisionedIops` string, int64 — Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. - `bootDiskType` string — Optional. Type of the boot disk (default is pd-standard). Valid values: pd-balanced (Persistent Disk Balanced Solid State Drive), pd-ssd (Persistent Disk Solid State Drive), or pd-standard (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types). - `bootDiskSizeGb` integer — Optional. Size in GB of the boot disk (default is 500GB). - `localSsdInterface` string — Optional. Interface type of local SSDs (default is scsi). Valid values: scsi (Small Computer System Interface), nvme (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance). - `bootDiskProvisionedThroughput` string, int64 — Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced. - `attachedDiskConfigs` AttachedDiskConfig[] — Optional. A list of attached disk configs for a group of VM instances. - … - `isPreemptible` boolean — Output only. Specifies that this instance group contains preemptible instances. - `machineTypeUri` string — Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement), you must use the short name of the machine type resource, for example, n1-standard-2. - `initializationActions` NodeInitializationAction[] — Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi - `executableFile` string — Required. Cloud Storage URI of executable file. - `executionTimeout` string, google-duration — Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period. - `masterConfig` InstanceGroupConfig — The config settings for Compute Engine resources in an instance group, such as a master or worker group. - `instanceNames` string[] — Output only. The list of instance names, derived from cluster_name, num_instances, and the instance group. - `preemptibility` 'PREEMPTIBILITY_UNSPECIFIED' | 'NON_PREEMPTIBLE' | 'PREEMPTIBLE' | 'SPOT' — Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE. - `minCpuPlatform` string — Optional. Specifies the minimum cpu platform for the Instance Group. See Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu). - `startupConfig` StartupConfig — Configuration to handle the startup of instances during cluster create and update process. - `requiredRegistrationFraction` number, double — Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). - `managedGroupConfig` ManagedGroupConfig — Specifies the resources used to actively manage an instance group. - `instanceGroupManagerUri` string — Output only. The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm. - `instanceTemplateName` string — Output only. The name of the Instance Template used for the Managed Instance Group. - `instanceGroupManagerName` string — Output only. The name of the Instance Group Manager for this group. - `minNumInstances` integer — Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted. - `instanceFlexibilityPolicy` InstanceFlexibilityPolicy — Instance flexibility Policy allowing a mixture of VM shapes and provisioning models. - `instanceMachineTypes` object — Output only. A map of instance short name to machine type. The key is the short name of the Compute Engine instance, and the value is the full machine-type name (e.g., 'n1-standard-16'). See Machine types for more information on valid machine type strings. - `instanceSelectionList` InstanceSelection[] — Optional. List of instance selection options that the group will use when creating new VMs. - … - `instanceSelectionResults` InstanceSelectionResult[] — Output only. A list of instance selection results in the group. - … - `provisioningModelMix` ProvisioningModelMix — Defines how to create VMs with a mixture of provisioning models. - … - `instanceReferences` InstanceReference[] — Output only. List of references to Compute Engine instances. - `publicKey` string — The public RSA key used for sharing data with this instance. - `publicEciesKey` string — The public ECIES key used for sharing data with this instance. - `instanceId` string — The unique identifier of the Compute Engine instance. - `instanceName` string — The user-friendly name of the Compute Engine instance. - `imageUri` string — Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. The service will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default. - `accelerators` AcceleratorConfig[] — Optional. The Compute Engine accelerator configuration for these instances. - `acceleratorTypeUri` string — Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 nvidia-tesla-t4Auto Zone Exception: If you are using Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement), you must use the short name of the accelerator type resource, for example, nvidia-tesla-t4. - `acceleratorCount` integer — The number of the accelerator cards of this type exposed to this instance. - `numInstances` integer — Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1. - `diskConfig` DiskConfig — Specifies the config of boot disk and attached disk options for a group of VM instances. - `numLocalSsds` integer — Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected. - `bootDiskProvisionedIops` string, int64 — Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced. - `bootDiskType` string — Optional. Type of the boot disk (default is pd-standard). Valid values: pd-balanced (Persistent Disk Balanced Solid State Drive), pd-ssd (Persistent Disk Solid State Drive), or pd-standard (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types). - `bootDiskSizeGb` integer — Optional. Size in GB of the boot disk (default is 500GB). - `localSsdInterface` string — Optional. Interface type of local SSDs (default is scsi). Valid values: scsi (Small Computer System Interface), nvme (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance). - `bootDiskProvisionedThroughput` string, int64 — Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced. - `attachedDiskConfigs` AttachedDiskConfig[] — Optional. A list of attached disk configs for a group of VM instances. - … - `isPreemptible` boolean — Output only. Specifies that this instance group contains preemptible instances. - `machineTypeUri` string — Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement), you must use the short name of the machine type resource, for example, n1-standard-2. - `configBucket` string — Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, the service will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. - `diagnosticBucket` string — Optional. A Cloud Storage bucket used to collect checkpoint diagnostic data (https://cloud.google.com/dataproc/docs/support/diagnose-clusters#checkpoint_diagnostic_data). If you do not specify a diagnostic bucket, The service will use the temp bucket to collect the checkpoint diagnostic data. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket. - `gceClusterConfig` GceClusterConfig — Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. - `nodeGroupAffinity` NodeGroupAffinity — Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. - `nodeGroupUri` string — Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 - `tags` string[] — The Compute Engine network tags to add to all instances (see Tagging instances (https://cloud.google.com/vpc/docs/add-remove-network-tags)). - `shieldedInstanceConfig` ShieldedInstanceConfig — Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm). - `enableSecureBoot` boolean — Optional. Defines whether instances have Secure Boot enabled. - `enableIntegrityMonitoring` boolean — Optional. Defines whether instances have integrity monitoring enabled. - `enableVtpm` boolean — Optional. Defines whether instances have the vTPM enabled. - `zoneUri` string — Optional. The Compute Engine zone where the cluster will be located. If omitted, the service will pick a zone in the cluster's Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] - `resourceManagerTags` object — Optional. Resource manager tags (https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing) to add to all instances (see Use secure tags (https://cloud.google.com/dataproc/docs/guides/use-secure-tags)). - `serviceAccountScopes` string[] — Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control - `autoZoneExcludeZoneUris` string[] — Optional. An optional list of Compute Engine zones where the cluster will not be located when Auto Zone is enabled. Only one of zone_uri or auto_zone_exclude_zone_uris can be set. If both are omitted, the service will pick a zone in the cluster Compute Engine region. If auto_zone_exclude_zone_uris is set and there is more than one non-excluded zone, the service will pick one of the non-excluded zones. Otherwise, cluster creation will fail with INVALID_ARGUMENT error.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone] - `subnetworkUri` string — Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/[region]/subnetworks/sub0 projects/[project_id]/regions/[region]/subnetworks/sub0 sub0 - `networkUri` string — Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default - `reservationAffinity` ReservationAffinity — Reservation Affinity for consuming Zonal reservation. - `key` string — Optional. Corresponds to the label key of reservation resource. - `values` string[] — Optional. Corresponds to the label values of reservation resource. - `consumeReservationType` 'TYPE_UNSPECIFIED' | 'NO_RESERVATION' | 'ANY_RESERVATION' | 'SPECIFIC_RESERVATION' — Optional. Type of reservation to consume - `internalIpOnly` boolean — Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.When set to true: All cluster VMs have internal IP addresses. Google Private Access (https://cloud.google.com/vpc/docs/private-google-access) must be enabled to access the Dataproc API and other Google Cloud APIs. Off-cluster dependencies must be configured to be accessible without external IP addresses.When set to false: Cluster VMs are not restricted to internal IP addresses. Ephemeral external IP addresses are assigned to each cluster VM. - `privateIpv6GoogleAccess` 'PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED' | 'INHERIT_FROM_SUBNETWORK' | 'OUTBOUND' | 'BIDIRECTIONAL' — Optional. The type of IPv6 access for a cluster. - `serviceAccount` string — Optional. The VM service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. - `metadata` object — Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). - `confidentialInstanceConfig` ConfidentialInstanceConfig — Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/confidential-computing/confidential-vm/docs) - `enableConfidentialCompute` boolean — Optional. Deprecated: Use 'confidential_instance_type' instead. Defines whether the instance should have confidential compute enabled. - `confidentialInstanceType` 'CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED' | 'SEV' | 'SEV_SNP' | 'TDX' — Optional. Defines the type of Confidential Compute technology to use. - `securityConfig` SecurityConfig — Security related configuration, including encryption, Kerberos, etc. - `identityConfig` IdentityConfig — Identity related configuration, including service account based secure multi-tenancy user mappings. - `userServiceAccountMapping` object — Required. Map of user to service account. - `kerberosConfig` KerberosConfig — Specifies Kerberos related configuration. - `crossRealmTrustRealm` string — Optional. The remote realm the on-cluster KDC will trust, should the user enable cross realm trust. - `crossRealmTrustAdminServer` string — Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. - `crossRealmTrustKdc` string — Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship. - `crossRealmTrustSharedPasswordUri` string — Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship. - `tgtLifetimeHours` integer — Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used. - `keystorePasswordUri` string — Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by the service. - `kmsKeyUri` string — Optional. The URI of the KMS key used to encrypt sensitive files. - `truststoreUri` string — Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, the service will provide a self-signed certificate. - `realm` string — Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm. - `keystoreUri` string — Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, the service will provide a self-signed certificate. - `keyPasswordUri` string — Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by the service. - `rootPrincipalPasswordUri` string — Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password. - `enableKerberos` boolean — Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster. - `truststorePasswordUri` string — Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by the service. - `kdcDbKeyUri` string — Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database. - `metastoreConfig` MetastoreConfig — Specifies a Metastore configuration. - `dataprocMetastoreService` string — Required. Resource name of an existing Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name] - `labels` object — Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster. - `clusterName` string — Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters. - `jobs` OrderedJob[] — Required. The Directed Acyclic Graph of Jobs to submit. - `prestoJob` PrestoJob — A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `queryList` QueryList — A list of queries to run on a cluster. - `queries` string[] — Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } - `outputFormat` string — Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats - `properties` object — Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI - `queryFileUri` string — The HCFS URI of the script that contains SQL queries. - `clientTags` string[] — Optional. Presto client tags to attach to this query - `continueOnFailure` boolean — Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. - `stepId` string — Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. - `hadoopJob` HadoopJob — A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). - `mainClass` string — The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris. - `args` string[] — Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision might occur that causes an incorrect job submission. - `fileUris` string[] — Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks. - `archiveUris` string[] — Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `mainJarFileUri` string — The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' - `jarFileUris` string[] — Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. - `properties` object — Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. - `flinkJob` FlinkJob — A Dataproc job for running Apache Flink applications on YARN. - `mainClass` string — The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris. - `args` string[] — Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision might occur that causes an incorrect job submission. - `savepointUri` string — Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `mainJarFileUri` string — The HCFS URI of the jar file that contains the main class. - `jarFileUris` string[] — Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks. - `properties` object — Optional. A mapping of property names to values, used to configure Flink. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/flink/conf/flink-defaults.conf and classes in user code. - `sparkRJob` SparkRJob — A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. - `fileUris` string[] — Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks. - `args` string[] — Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - `properties` object — Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `mainRFileUri` string — Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. - `archiveUris` string[] — Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. - `trinoJob` TrinoJob — A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster. - `queryList` QueryList — A list of queries to run on a cluster. - `queries` string[] — Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } - `outputFormat` string — Optional. The format in which query output will be displayed. See the Trino documentation for supported output formats - `properties` object — Optional. A mapping of property names to values. Used to set Trino session properties (https://trino.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Trino CLI - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `continueOnFailure` boolean — Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. - `queryFileUri` string — The HCFS URI of the script that contains SQL queries. - `clientTags` string[] — Optional. Trino client tags to attach to this query - `prerequisiteStepIds` string[] — Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. - `hiveJob` HiveJob — A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. - `queryList` QueryList — A list of queries to run on a cluster. - `queries` string[] — Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } - `properties` object — Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code. - `jarFileUris` string[] — Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. - `queryFileUri` string — The HCFS URI of the script that contains Hive queries. - `scriptVariables` object — Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";). - `continueOnFailure` boolean — Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. - `scheduling` JobScheduling — Job scheduling options. - `maxFailuresPerHour` integer — Optional. Maximum number of times per hour a driver can be restarted as a result of driver exiting with non-zero code before job is reported failed.A job might be reported as thrashing if the driver exits with a non-zero code four times within a 10-minute window.Maximum value is 10.Note: This restartable job option is not supported in Dataproc workflow templates (https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template). - `maxFailuresTotal` integer — Optional. Maximum total number of times a driver can be restarted as a result of the driver exiting with a non-zero code. After the maximum number is reached, the job will be reported as failed.Maximum value is 240.Note: Currently, this restartable job option is not supported in Dataproc workflow templates (https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template). - `labels` object — Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job. - `sparkJob` SparkJob — A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN. - `mainClass` string — The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in SparkJob.jar_file_uris. - `args` string[] — Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - `fileUris` string[] — Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks. - `archiveUris` string[] — Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `mainJarFileUri` string — The HCFS URI of the jar file that contains the main class. - `jarFileUris` string[] — Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. - `properties` object — Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. - `sparkSqlJob` SparkSqlJob — A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `queryList` QueryList — A list of queries to run on a cluster. - `queries` string[] — Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } - `properties` object — Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API might be overwritten. - `jarFileUris` string[] — Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. - `queryFileUri` string — The HCFS URI of the script that contains SQL queries. - `scriptVariables` object — Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";). - `pysparkJob` PySparkJob — A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/latest/api/python/index.html#pyspark-overview) applications on YARN. - `jarFileUris` string[] — Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. - `properties` object — Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `pythonFileUris` string[] — Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. - `archiveUris` string[] — Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.Note: Spark applications must be deployed in cluster mode (https://spark.apache.org/docs/latest/cluster-overview.html) for correct environment propagation. - `fileUris` string[] — Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks. - `mainPythonFileUri` string — Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. - `args` string[] — Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission. - `pigJob` PigJob — A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. - `scriptVariables` object — Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]). - `continueOnFailure` boolean — Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. - `queryFileUri` string — The HCFS URI of the script that contains the Pig queries. - `loggingConfig` LoggingConfig — The runtime logging config of the job. - `driverLogLevels` object — The per-package log levels for the driver. This can include "root" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG' - `queryList` QueryList — A list of queries to run on a cluster. - `queries` string[] — Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } } - `properties` object — Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code. - `jarFileUris` string[] — Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. - `dagTimeout` string, google-duration — Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted. - `name` string — Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} - `parameters` TemplateParameter[] — Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. - `name` string — Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters. - `description` string — Optional. Brief description of the parameter. Must not exceed 1024 characters. - `fields` string[] — Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args - `validation` ParameterValidation — Configuration for parameter validation. - `regex` RegexValidation — Validation based on regular expressions. - `regexes` string[] — Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient). - `values` ValueValidation — Validation based on a list of allowed values. - `values` string[] — Required. List of allowed values for the parameter. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/dataproc.md) · [All operations](https://skmtc.net/google/apis/dataproc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dataproc/versions/15847ccbcf7d/schema)