Blame - docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html - platform/external/python/google-api-python-client

<h1><a href="dataproc_v1.html">Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.regions.html">regions</a> . <a href="dataproc_v1.projects.regions.workflowTemplates.html">workflowTemplates</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>

79

<p class="firstline">Creates new workflow template.</p>

80

81

<code><a href="#delete">delete(name, version=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Deletes a workflow template. It does not cancel in-progress workflows.</p>

83

84

<code><a href="#get">get(name, version=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.</p>

86

87

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>

89

90

<code><a href="#instantiate">instantiate(name, body, x__xgafv=None)</a></code></p>

91

<p class="firstline">Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.</p>

92

93

<code><a href="#instantiateInline">instantiateInline(parent, body, requestId=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.</p>

95

96

<code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>

97

<p class="firstline">Lists workflows that match the specified filter in the request.</p>

98

99

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

100

<p class="firstline">Retrieves the next page of results.</p>

101

102

<code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

104

105

<code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>

106

<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>

107

108

<code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>

109

<p class="firstline">Updates (replaces) workflow template. The updated template must contain version that matches the current server version.</p>

110

<h3>Method Details</h3>

111

112

<code class="details" id="create">create(parent, body, x__xgafv=None)</code>

113

<pre>Creates new workflow template.

114

115

Args:

116

parent: string, Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} (required)

117

body: object, The request body. (required)

118

The object takes the form of:

119

120

{ # A Cloud Dataproc workflow template resource.

121

"updateTime": "A String", # Output only. The time template was last updated.

122

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

123

"clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.

124

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

125

"a_key": "A String",

126

},

127

"zone": "A 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.

128

},

129

"managedCluster": { # Cluster that is managed by the workflow. # Optional. A cluster that is managed by the workflow.

130

"clusterName": "A 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.

131

"labels": { # 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.

132

"a_key": "A String",

133

},

134

"config": { # The cluster config. # Required. The cluster configuration.

135

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

136

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.

137

"optionalComponents": [ # The set of optional components to activate on the cluster.

138

"A String",

139

],

140

"properties": { # 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:

141

# capacity-scheduler: capacity-scheduler.xml

142

# core: core-site.xml

143

# distcp: distcp-default.xml

144

# hdfs: hdfs-site.xml

145

# hive: hive-site.xml

146

# mapred: mapred-site.xml

147

# pig: pig.properties

148

# spark: spark-defaults.conf

149

# yarn: yarn-site.xmlFor more information, see Cluster properties.

"a_key": "A String",

},

},

"configBucket": "A String", # Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).

154

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

155

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

156

"networkUri": "A 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 for more information).A full URL, partial URI, or short name are valid. Examples:

157

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

158

# projects/[project_id]/regions/global/default

159

# default

160

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).

161

"A String",

162

],

163

"serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:

164

# roles/logging.logWriter

165

# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com

166

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

167

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

168

# projects/[project_id]/zones/[zone]

169

# us-central1-f

170

"subnetworkUri": "A 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:

171

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

172

# projects/[project_id]/regions/us-east1/subnetworks/sub0

173

# sub0

174

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

175

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

176

# https://www.googleapis.com/auth/devstorage.read_write

177

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

178

# https://www.googleapis.com/auth/bigquery

179

# https://www.googleapis.com/auth/bigtable.admin.table

180

# https://www.googleapis.com/auth/bigtable.data

181

# https://www.googleapis.com/auth/devstorage.full_control

182

"A String",

183

],

184

"metadata": { # 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)).

"a_key": "A String",

},

},

"workerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

189

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

190

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

191

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

192

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

193

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

194

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

195

"A String",

196

],

197

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

198

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

199

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

200

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

201

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

202

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

203

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

204

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

205

},

206

],

207

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

208

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

209

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

210

},

211

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

212

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

213

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

214

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

215

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

216

},

217

},

218

"initializationActions": [ # 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):

219

# ROLE=$(curl -H Metadata-Flavor:Google

220

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

221

# if [[ "${ROLE}" == 'Master' ]]; then

222

# ... master specific actions ...

223

# else

224

# ... worker specific actions ...

225

# fi

226

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

227

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.

228

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

229

},

230

],

231

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

232

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

233

},

234

"secondaryWorkerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

235

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

236

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

237

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

238

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

239

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

240

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

241

"A String",

242

],

243

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

244

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

245

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

246

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

247

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

248

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

249

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

250

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

251

},

252

],

253

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

254

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

255

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

256

},

257

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

258

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

259

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

260

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

261

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

262

},

263

},

264

"masterConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

265

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

266

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

267

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

268

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

269

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

270

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

271

"A String",

272

],

273

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

274

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

275

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

276

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

277

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

278

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

279

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

280

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

281

},

282

],

283

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

284

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

285

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

286

},

287

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

288

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

289

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

290

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

291

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

292

},

293

},

294

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

295

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

296

"truststorePasswordUri": "A 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 Dataproc.

297

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

298

"keyPasswordUri": "A 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 Dataproc.

299

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.

300

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

301

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

302

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

303

"keystorePasswordUri": "A 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 Dataproc.

304

"crossRealmTrustSharedPasswordUri": "A 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.

305

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

306

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

307

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

308

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

309

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

},

},

},

},

},

"name": "A String", # Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

316

"parameters": [ # Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

317

{ # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

318

"fields": [ # 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:

319

# Values in maps can be referenced by key:

320

# labels'key'

321

# placement.clusterSelector.clusterLabels'key'

322

# placement.managedCluster.labels'key'

323

# placement.clusterSelector.clusterLabels'key'

324

# jobs'step-id'.labels'key'

325

# Jobs in the jobs list can be referenced by step-id:

326

# jobs'step-id'.hadoopJob.mainJarFileUri

327

# jobs'step-id'.hiveJob.queryFileUri

328

# jobs'step-id'.pySparkJob.mainPythonFileUri

329

# jobs'step-id'.hadoopJob.jarFileUris0

330

# jobs'step-id'.hadoopJob.archiveUris0

331

# jobs'step-id'.hadoopJob.fileUris0

332

# jobs'step-id'.pySparkJob.pythonFileUris0

333

# Items in repeated fields can be referenced by a zero-based index:

334

# jobs'step-id'.sparkJob.args0

335

# Other examples:

336

# jobs'step-id'.hadoopJob.properties'key'

337

# jobs'step-id'.hadoopJob.args0

338

# jobs'step-id'.hiveJob.scriptVariables'key'

339

# jobs'step-id'.hadoopJob.mainJarFileUri

340

# 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:

341

# placement.clusterSelector.clusterLabels

342

# jobs'step-id'.sparkJob.args

343

"A String",

344

],

345

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

346

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

347

"regexes": [ # 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).

"A String",

],

},

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

352

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

},

"name": "A 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.

358

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

359

},

360

],

361

"labels": { # 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.

362

"a_key": "A String",

363

},

364

"createTime": "A String", # Output only. The time template was created.

365

"version": 42, # 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.

366

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

367

{ # A job executed by the workflow.

368

"hadoopJob": { # A Cloud 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). # Job is a Hadoop job.

369

"args": [ # 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 may occur that causes an incorrect job submission.

370

"A String",

371

],

372

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

373

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

378

"A String",

379

],

380

"fileUris": [ # 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.

381

"A String",

382

],

383

"mainClass": "A 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.

384

"archiveUris": [ # 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.

385

"A String",

386

],

387

"mainJarFileUri": "A 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'

388

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

"a_key": "A String",

},

},

"stepId": "A 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.

393

"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.

394

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

395

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

396

"a_key": "A String",

397

},

398

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

399

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

404

"A String",

405

],

406

"queryList": { # A list of queries to run on a cluster. # A list of queries.

407

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.

"a_key": "A String",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

425

"A String",

426

],

427

"pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.

428

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

429

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

430

"a_key": "A String",

431

},

432

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

433

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

438

"A String",

439

],

440

"queryList": { # A list of queries to run on a cluster. # A list of queries.

441

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

455

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.

"a_key": "A String",

},

},

"labels": { # 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.

460

"a_key": "A String",

461

},

462

"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.

463

"args": [ # 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.

464

"A String",

465

],

466

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

467

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

472

"A String",

473

],

474

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

475

"A String",

476

],

477

"mainClass": "A 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 jar_file_uris.

478

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

479

"A String",

480

],

481

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

482

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

487

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

488

},

489

"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.

490

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

491

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

492

"A String",

493

],

494

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

495

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"args": [ # 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.

500

"A String",

501

],

502

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

503

"A String",

504

],

505

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

506

"A String",

507

],

508

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

509

"A String",

510

],

511

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.

516

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

517

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

518

"a_key": "A String",

519

},

520

"jarFileUris": [ # 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.

521

"A String",

522

],

523

"queryList": { # A list of queries to run on a cluster. # A list of queries.

524

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

538

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

},

],

"id": "A String", # Required. The template id.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.

545

}

546

547

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

554

555

{ # A Cloud Dataproc workflow template resource.

556

"updateTime": "A String", # Output only. The time template was last updated.

557

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

558

"clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.

559

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

560

"a_key": "A String",

561

},

562

"zone": "A 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.

563

},

564

"managedCluster": { # Cluster that is managed by the workflow. # Optional. A cluster that is managed by the workflow.

565

"clusterName": "A 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.

566

"labels": { # 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.

567

"a_key": "A String",

568

},

569

"config": { # The cluster config. # Required. The cluster configuration.

570

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

571

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.

572

"optionalComponents": [ # The set of optional components to activate on the cluster.

573

"A String",

574

],

575

"properties": { # 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:

576

# capacity-scheduler: capacity-scheduler.xml

577

# core: core-site.xml

578

# distcp: distcp-default.xml

579

# hdfs: hdfs-site.xml

580

# hive: hive-site.xml

581

# mapred: mapred-site.xml

582

# pig: pig.properties

583

# spark: spark-defaults.conf

584

# yarn: yarn-site.xmlFor more information, see Cluster properties.

"a_key": "A String",

},

},

"configBucket": "A String", # Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).

589

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

590

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

591

"networkUri": "A 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 for more information).A full URL, partial URI, or short name are valid. Examples:

592

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

593

# projects/[project_id]/regions/global/default

594

# default

595

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).

596

"A String",

597

],

598

"serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:

599

# roles/logging.logWriter

600

# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com

601

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

602

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

603

# projects/[project_id]/zones/[zone]

604

# us-central1-f

605

"subnetworkUri": "A 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:

606

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

607

# projects/[project_id]/regions/us-east1/subnetworks/sub0

608

# sub0

609

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

610

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

611

# https://www.googleapis.com/auth/devstorage.read_write

612

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

613

# https://www.googleapis.com/auth/bigquery

614

# https://www.googleapis.com/auth/bigtable.admin.table

615

# https://www.googleapis.com/auth/bigtable.data

616

# https://www.googleapis.com/auth/devstorage.full_control

617

"A String",

618

],

619

"metadata": { # 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)).

"a_key": "A String",

},

},

"workerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

624

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

625

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

626

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

627

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

628

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

629

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

630

"A String",

631

],

632

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

633

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

634

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

635

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

636

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

637

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

638

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

639

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

640

},

641

],

642

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

643

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

644

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

645

},

646

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

647

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

648

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

649

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

650

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

651

},

652

},

653

"initializationActions": [ # 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):

654

# ROLE=$(curl -H Metadata-Flavor:Google

655

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

656

# if [[ "${ROLE}" == 'Master' ]]; then

657

# ... master specific actions ...

658

# else

659

# ... worker specific actions ...

660

# fi

661

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

662

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.

663

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

664

},

665

],

666

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

667

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

668

},

669

"secondaryWorkerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

670

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

671

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

672

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

673

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

674

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

675

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

676

"A String",

677

],

678

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

679

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

680

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

681

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

682

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

683

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

684

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

685

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

686

},

687

],

688

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

689

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

690

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

691

},

692

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

693

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

694

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

695

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

696

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

697

},

698

},

699

"masterConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

700

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

701

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

702

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

703

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

704

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

705

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

706

"A String",

707

],

708

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

709

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

710

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

711

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

712

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

713

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

714

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

715

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

716

},

717

],

718

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

719

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

720

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

721

},

722

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

723

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

724

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

725

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

726

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

727

},

728

},

729

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

730

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

731

"truststorePasswordUri": "A 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 Dataproc.

732

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

733

"keyPasswordUri": "A 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 Dataproc.

734

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.

735

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

736

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

737

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

738

"keystorePasswordUri": "A 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 Dataproc.

739

"crossRealmTrustSharedPasswordUri": "A 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.

740

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

741

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

742

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

743

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

744

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

},

},

},

},

},

"name": "A String", # Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

751

"parameters": [ # Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

752

{ # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

753

"fields": [ # 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:

754

# Values in maps can be referenced by key:

755

# labels'key'

756

# placement.clusterSelector.clusterLabels'key'

757

# placement.managedCluster.labels'key'

758

# placement.clusterSelector.clusterLabels'key'

759

# jobs'step-id'.labels'key'

760

# Jobs in the jobs list can be referenced by step-id:

761

# jobs'step-id'.hadoopJob.mainJarFileUri

762

# jobs'step-id'.hiveJob.queryFileUri

763

# jobs'step-id'.pySparkJob.mainPythonFileUri

764

# jobs'step-id'.hadoopJob.jarFileUris0

765

# jobs'step-id'.hadoopJob.archiveUris0

766

# jobs'step-id'.hadoopJob.fileUris0

767

# jobs'step-id'.pySparkJob.pythonFileUris0

768

# Items in repeated fields can be referenced by a zero-based index:

769

# jobs'step-id'.sparkJob.args0

770

# Other examples:

771

# jobs'step-id'.hadoopJob.properties'key'

772

# jobs'step-id'.hadoopJob.args0

773

# jobs'step-id'.hiveJob.scriptVariables'key'

774

# jobs'step-id'.hadoopJob.mainJarFileUri

775

# 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:

776

# placement.clusterSelector.clusterLabels

777

# jobs'step-id'.sparkJob.args

778

"A String",

779

],

780

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

781

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

782

"regexes": [ # 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).

"A String",

],

},

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

787

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

},

"name": "A 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.

793

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

794

},

795

],

796

"labels": { # 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.

797

"a_key": "A String",

798

},

799

"createTime": "A String", # Output only. The time template was created.

800

"version": 42, # 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.

801

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

802

{ # A job executed by the workflow.

803

"hadoopJob": { # A Cloud 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). # Job is a Hadoop job.

804

"args": [ # 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 may occur that causes an incorrect job submission.

805

"A String",

806

],

807

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

808

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

813

"A String",

814

],

815

"fileUris": [ # 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.

816

"A String",

817

],

818

"mainClass": "A 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.

819

"archiveUris": [ # 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.

820

"A String",

821

],

822

"mainJarFileUri": "A 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'

823

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

"a_key": "A String",

},

},

"stepId": "A 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.

828

"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.

829

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

830

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

831

"a_key": "A String",

832

},

833

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

834

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

839

"A String",

840

],

841

"queryList": { # A list of queries to run on a cluster. # A list of queries.

842

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.

"a_key": "A String",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

860

"A String",

861

],

862

"pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.

863

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

864

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

865

"a_key": "A String",

866

},

867

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

868

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

873

"A String",

874

],

875

"queryList": { # A list of queries to run on a cluster. # A list of queries.

876

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

890

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.

"a_key": "A String",

},

},

"labels": { # 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.

895

"a_key": "A String",

896

},

897

"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.

898

"args": [ # 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.

899

"A String",

900

],

901

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

902

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

907

"A String",

908

],

909

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

910

"A String",

911

],

912

"mainClass": "A 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 jar_file_uris.

913

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

914

"A String",

915

],

916

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

917

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

922

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

923

},

924

"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.

925

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

926

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

927

"A String",

928

],

929

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

930

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"args": [ # 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.

935

"A String",

936

],

937

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

938

"A String",

939

],

940

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

941

"A String",

942

],

943

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

944

"A String",

945

],

946

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.

951

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

952

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

953

"a_key": "A String",

954

},

955

"jarFileUris": [ # 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.

956

"A String",

957

],

958

"queryList": { # A list of queries to run on a cluster. # A list of queries.

959

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

973

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

},

],

"id": "A String", # Required. The template id.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.

}</pre>

</div>

<code class="details" id="delete">delete(name, version=None, x__xgafv=None)</code>

985

<pre>Deletes a workflow template. It does not cancel in-progress workflows.

986

987

Args:

988

name: string, Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} (required)

989

version: integer, Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.

990

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

997

998

{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

999

# service Foo {

1000

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1001

# }

1002

# The JSON representation for Empty is empty JSON object {}.

}</pre>

</div>

<code class="details" id="get">get(name, version=None, x__xgafv=None)</code>

1008

<pre>Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.

1009

1010

Args:

1011

name: string, Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} (required)

1012

version: integer, Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.

1013

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1020

1021

{ # A Cloud Dataproc workflow template resource.

1022

"updateTime": "A String", # Output only. The time template was last updated.

1023

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

1024

"clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.

1025

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

1026

"a_key": "A String",

1027

},

1028

"zone": "A 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.

1029

},

1030

"managedCluster": { # Cluster that is managed by the workflow. # Optional. A cluster that is managed by the workflow.

1031

"clusterName": "A 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.

1032

"labels": { # 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.

1033

"a_key": "A String",

1034

},

1035

"config": { # The cluster config. # Required. The cluster configuration.

1036

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

1037

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.

1038

"optionalComponents": [ # The set of optional components to activate on the cluster.

1039

"A String",

1040

],

1041

"properties": { # 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:

1042

# capacity-scheduler: capacity-scheduler.xml

1043

# core: core-site.xml

1044

# distcp: distcp-default.xml

1045

# hdfs: hdfs-site.xml

1046

# hive: hive-site.xml

1047

# mapred: mapred-site.xml

1048

# pig: pig.properties

1049

# spark: spark-defaults.conf

1050

# yarn: yarn-site.xmlFor more information, see Cluster properties.

"a_key": "A String",

},

},

"configBucket": "A String", # Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).

1055

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

1056

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

1057

"networkUri": "A 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 for more information).A full URL, partial URI, or short name are valid. Examples:

1058

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

1059

# projects/[project_id]/regions/global/default

1060

# default

1061

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).

1062

"A String",

1063

],

1064

"serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:

1065

# roles/logging.logWriter

1066

# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com

1067

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

1068

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

1069

# projects/[project_id]/zones/[zone]

1070

# us-central1-f

1071

"subnetworkUri": "A 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:

1072

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

1073

# projects/[project_id]/regions/us-east1/subnetworks/sub0

1074

# sub0

1075

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

1076

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

1077

# https://www.googleapis.com/auth/devstorage.read_write

1078

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

1079

# https://www.googleapis.com/auth/bigquery

1080

# https://www.googleapis.com/auth/bigtable.admin.table

1081

# https://www.googleapis.com/auth/bigtable.data

1082

# https://www.googleapis.com/auth/devstorage.full_control

1083

"A String",

1084

],

1085

"metadata": { # 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)).

"a_key": "A String",

},

},

"workerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

1090

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

1091

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1092

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1093

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1094

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1095

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

1096

"A String",

1097

],

1098

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

1099

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

1100

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

1101

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1102

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

1103

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1104

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1105

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1106

},

1107

],

1108

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1109

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1110

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1111

},

1112

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1113

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1114

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

1115

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1116

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1117

},

1118

},

1119

"initializationActions": [ # 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):

1120

# ROLE=$(curl -H Metadata-Flavor:Google

1121

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

1122

# if [[ "${ROLE}" == 'Master' ]]; then

1123

# ... master specific actions ...

1124

# else

1125

# ... worker specific actions ...

1126

# fi

1127

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

1128

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.

1129

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

1130

},

1131

],

1132

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

1133

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

1134

},

1135

"secondaryWorkerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

1136

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

1137

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1138

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1139

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1140

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1141

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

1142

"A String",

1143

],

1144

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

1145

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

1146

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

1147

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1148

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

1149

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1150

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1151

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1152

},

1153

],

1154

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1155

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1156

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1157

},

1158

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1159

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1160

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

1161

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1162

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1163

},

1164

},

1165

"masterConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

1166

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

1167

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1168

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1169

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1170

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1171

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

1172

"A String",

1173

],

1174

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

1175

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

1176

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

1177

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1178

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

1179

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1180

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1181

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1182

},

1183

],

1184

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1185

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1186

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1187

},

1188

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1189

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1190

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

1191

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1192

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1193

},

1194

},

1195

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

1196

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

1197

"truststorePasswordUri": "A 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 Dataproc.

1198

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

1199

"keyPasswordUri": "A 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 Dataproc.

1200

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.

1201

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1202

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

1203

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1204

"keystorePasswordUri": "A 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 Dataproc.

1205

"crossRealmTrustSharedPasswordUri": "A 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.

1206

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1207

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1208

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

1209

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

1210

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

},

},

},

},

},

"name": "A String", # Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

1217

"parameters": [ # Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

1218

{ # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

1219

"fields": [ # 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:

1220

# Values in maps can be referenced by key:

1221

# labels'key'

1222

# placement.clusterSelector.clusterLabels'key'

1223

# placement.managedCluster.labels'key'

1224

# placement.clusterSelector.clusterLabels'key'

1225

# jobs'step-id'.labels'key'

1226

# Jobs in the jobs list can be referenced by step-id:

1227

# jobs'step-id'.hadoopJob.mainJarFileUri

1228

# jobs'step-id'.hiveJob.queryFileUri

1229

# jobs'step-id'.pySparkJob.mainPythonFileUri

1230

# jobs'step-id'.hadoopJob.jarFileUris0

1231

# jobs'step-id'.hadoopJob.archiveUris0

1232

# jobs'step-id'.hadoopJob.fileUris0

1233

# jobs'step-id'.pySparkJob.pythonFileUris0

1234

# Items in repeated fields can be referenced by a zero-based index:

1235

# jobs'step-id'.sparkJob.args0

1236

# Other examples:

1237

# jobs'step-id'.hadoopJob.properties'key'

1238

# jobs'step-id'.hadoopJob.args0

1239

# jobs'step-id'.hiveJob.scriptVariables'key'

1240

# jobs'step-id'.hadoopJob.mainJarFileUri

1241

# 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:

1242

# placement.clusterSelector.clusterLabels

1243

# jobs'step-id'.sparkJob.args

1244

"A String",

1245

],

1246

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

1247

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

1248

"regexes": [ # 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).

"A String",

],

},

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

1253

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

},

"name": "A 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.

1259

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

1260

},

1261

],

1262

"labels": { # 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.

1263

"a_key": "A String",

1264

},

1265

"createTime": "A String", # Output only. The time template was created.

1266

"version": 42, # 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.

1267

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

1268

{ # A job executed by the workflow.

1269

"hadoopJob": { # A Cloud 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). # Job is a Hadoop job.

1270

"args": [ # 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 may occur that causes an incorrect job submission.

1271

"A String",

1272

],

1273

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1274

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

1279

"A String",

1280

],

1281

"fileUris": [ # 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.

1282

"A String",

1283

],

1284

"mainClass": "A 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.

1285

"archiveUris": [ # 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.

1286

"A String",

1287

],

1288

"mainJarFileUri": "A 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'

1289

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

"a_key": "A String",

},

},

"stepId": "A 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.

1294

"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.

1295

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1296

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

1297

"a_key": "A String",

1298

},

1299

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1300

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

1305

"A String",

1306

],

1307

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1308

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.

"a_key": "A String",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

1326

"A String",

1327

],

1328

"pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.

1329

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

1330

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

1331

"a_key": "A String",

1332

},

1333

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1334

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

1339

"A String",

1340

],

1341

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1342

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

1356

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.

"a_key": "A String",

},

},

"labels": { # 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.

1361

"a_key": "A String",

1362

},

1363

"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.

1364

"args": [ # 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.

1365

"A String",

1366

],

1367

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1368

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

1373

"A String",

1374

],

1375

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

1376

"A String",

1377

],

1378

"mainClass": "A 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 jar_file_uris.

1379

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1380

"A String",

1381

],

1382

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

1383

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

1388

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

1389

},

1390

"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.

1391

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

1392

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

1393

"A String",

1394

],

1395

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1396

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"args": [ # 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.

1401

"A String",

1402

],

1403

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

1404

"A String",

1405

],

1406

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

1407

"A String",

1408

],

1409

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

1410

"A String",

1411

],

1412

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.

1417

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

1418

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

1419

"a_key": "A String",

1420

},

1421

"jarFileUris": [ # 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.

1422

"A String",

1423

],

1424

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1425

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

1439

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

},

],

"id": "A String", # Required. The template id.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.

}</pre>

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

1451

<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

1452

1453

Args:

1454

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

1455

body: object, The request body.

1456

The object takes the form of:

1457

1458

{ # Request message for GetIamPolicy method.

1459

}

1460

1461

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1468

1469

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example

# {

# "bindings": [

# {

# "role": "roles/owner",

1474

# "members": [

1475

# "user:mike@example.com",

1476

# "group:admins@example.com",

1477

# "domain:google.com",

1478

# "serviceAccount:my-other-app@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/viewer",

1483

# "members": ["user:sean@example.com"]

# }

# ]

# }

# YAML Example

# bindings:

# - members:

# - user:mike@example.com

1491

# - group:admins@example.com

1492

# - domain:google.com

1493

# - serviceAccount:my-other-app@appspot.gserviceaccount.com

1494

# role: roles/owner

1495

# - members:

1496

# - user:sean@example.com

1497

# role: roles/viewer

1498

# For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).

1499

"bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.

1500

{ # Associates members with a role.

1501

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

1502

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

1503

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

1504

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

1505

# user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .

1506

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

1507

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

1508

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

1509

"A String",

1510

],

1511

"condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.

1512

# title: "User account presence"

1513

# description: "Determines whether the request has a user account"

1514

# expression: "size(request.user) > 0"

1515

"location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1516

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.

1517

"description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1518

"title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

},

},

],

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

1523

"version": 42, # Deprecated.

}</pre>

</div>

<code class="details" id="instantiate">instantiate(name, body, x__xgafv=None)</code>

1529

<pre>Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

1530

1531

Args:

1532

name: string, Required. The "resource name" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} (required)

1533

body: object, The request body. (required)

1534

The object takes the form of:

1535

1536

{ # A request to instantiate a workflow template.

1537

"version": 42, # Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.

1538

"requestId": "A String", # Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

1539

"parameters": { # Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters.

"a_key": "A String",

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1551

1552

{ # This resource represents a long-running operation that is the result of a network API call.

1553

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1554

"a_key": "", # Properties of the object. Contains field @type with type URL.

1555

},

1556

"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

1557

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

1558

"a_key": "", # Properties of the object. Contains field @type with type URL.

1559

},

1560

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

1561

"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

1562

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1563

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1564

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1565

{

1566

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}</pre>

</div>

<code class="details" id="instantiateInline">instantiateInline(parent, body, requestId=None, x__xgafv=None)</code>

1575

<pre>Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.

1576

1577

Args:

1578

parent: string, Required. The "resource name" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} (required)

1579

body: object, The request body. (required)

1580

The object takes the form of:

1581

1582

{ # A Cloud Dataproc workflow template resource.

1583

"updateTime": "A String", # Output only. The time template was last updated.

1584

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

1585

"clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.

1586

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

1587

"a_key": "A String",

1588

},

1589

"zone": "A 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.

1590

},

1591

"managedCluster": { # Cluster that is managed by the workflow. # Optional. A cluster that is managed by the workflow.

1592

"clusterName": "A 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.

1593

"labels": { # 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.

1594

"a_key": "A String",

1595

},

1596

"config": { # The cluster config. # Required. The cluster configuration.

1597

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

1598

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.

1599

"optionalComponents": [ # The set of optional components to activate on the cluster.

1600

"A String",

1601

],

1602

"properties": { # 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:

1603

# capacity-scheduler: capacity-scheduler.xml

1604

# core: core-site.xml

1605

# distcp: distcp-default.xml

1606

# hdfs: hdfs-site.xml

1607

# hive: hive-site.xml

1608

# mapred: mapred-site.xml

1609

# pig: pig.properties

1610

# spark: spark-defaults.conf

1611

# yarn: yarn-site.xmlFor more information, see Cluster properties.

"a_key": "A String",

},

},

"configBucket": "A String", # Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).

1616

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

1617

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

1618

"networkUri": "A 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 for more information).A full URL, partial URI, or short name are valid. Examples:

1619

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

1620

# projects/[project_id]/regions/global/default

1621

# default

1622

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).

1623

"A String",

1624

],

1625

"serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:

1626

# roles/logging.logWriter

1627

# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com

1628

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

1629

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

1630

# projects/[project_id]/zones/[zone]

1631

# us-central1-f

1632

"subnetworkUri": "A 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:

1633

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

1634

# projects/[project_id]/regions/us-east1/subnetworks/sub0

1635

# sub0

1636

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

1637

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

1638

# https://www.googleapis.com/auth/devstorage.read_write

1639

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

1640

# https://www.googleapis.com/auth/bigquery

1641

# https://www.googleapis.com/auth/bigtable.admin.table

1642

# https://www.googleapis.com/auth/bigtable.data

1643

# https://www.googleapis.com/auth/devstorage.full_control

1644

"A String",

1645

],

1646

"metadata": { # 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)).

"a_key": "A String",

},

},

"workerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

1651

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

1652

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1653

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1654

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1655

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1656

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

1657

"A String",

1658

],

1659

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

1660

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

1661

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

1662

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1663

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

1664

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1665

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1666

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1667

},

1668

],

1669

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1670

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1671

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1672

},

1673

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1674

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1675

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

1676

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1677

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1678

},

1679

},

1680

"initializationActions": [ # 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):

1681

# ROLE=$(curl -H Metadata-Flavor:Google

1682

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

1683

# if [[ "${ROLE}" == 'Master' ]]; then

1684

# ... master specific actions ...

1685

# else

1686

# ... worker specific actions ...

1687

# fi

1688

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

1689

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.

1690

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

1691

},

1692

],

1693

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

1694

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

1695

},

1696

"secondaryWorkerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

1697

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

1698

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1699

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1700

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1701

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1702

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

1703

"A String",

1704

],

1705

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

1706

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

1707

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

1708

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1709

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

1710

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1711

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1712

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1713

},

1714

],

1715

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1716

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1717

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1718

},

1719

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1720

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1721

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

1722

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1723

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1724

},

1725

},

1726

"masterConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

1727

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

1728

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1729

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1730

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1731

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1732

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

1733

"A String",

1734

],

1735

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

1736

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

1737

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

1738

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1739

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

1740

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1741

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1742

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1743

},

1744

],

1745

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1746

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1747

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1748

},

1749

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1750

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1751

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

1752

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1753

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1754

},

1755

},

1756

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

1757

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

1758

"truststorePasswordUri": "A 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 Dataproc.

1759

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

1760

"keyPasswordUri": "A 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 Dataproc.

1761

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.

1762

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1763

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

1764

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1765

"keystorePasswordUri": "A 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 Dataproc.

1766

"crossRealmTrustSharedPasswordUri": "A 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.

1767

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1768

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1769

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

1770

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

1771

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

},

},

},

},

},

"name": "A String", # Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

1778

"parameters": [ # Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

1779

{ # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

1780

"fields": [ # 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:

1781

# Values in maps can be referenced by key:

1782

# labels'key'

1783

# placement.clusterSelector.clusterLabels'key'

1784

# placement.managedCluster.labels'key'

1785

# placement.clusterSelector.clusterLabels'key'

1786

# jobs'step-id'.labels'key'

1787

# Jobs in the jobs list can be referenced by step-id:

1788

# jobs'step-id'.hadoopJob.mainJarFileUri

1789

# jobs'step-id'.hiveJob.queryFileUri

1790

# jobs'step-id'.pySparkJob.mainPythonFileUri

1791

# jobs'step-id'.hadoopJob.jarFileUris0

1792

# jobs'step-id'.hadoopJob.archiveUris0

1793

# jobs'step-id'.hadoopJob.fileUris0

1794

# jobs'step-id'.pySparkJob.pythonFileUris0

1795

# Items in repeated fields can be referenced by a zero-based index:

1796

# jobs'step-id'.sparkJob.args0

1797

# Other examples:

1798

# jobs'step-id'.hadoopJob.properties'key'

1799

# jobs'step-id'.hadoopJob.args0

1800

# jobs'step-id'.hiveJob.scriptVariables'key'

1801

# jobs'step-id'.hadoopJob.mainJarFileUri

1802

# 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:

1803

# placement.clusterSelector.clusterLabels

1804

# jobs'step-id'.sparkJob.args

1805

"A String",

1806

],

1807

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

1808

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

1809

"regexes": [ # 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).

"A String",

],

},

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

1814

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

},

"name": "A 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.

1820

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

1821

},

1822

],

1823

"labels": { # 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.

1824

"a_key": "A String",

1825

},

1826

"createTime": "A String", # Output only. The time template was created.

1827

"version": 42, # 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.

1828

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

1829

{ # A job executed by the workflow.

1830

"hadoopJob": { # A Cloud 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). # Job is a Hadoop job.

1831

"args": [ # 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 may occur that causes an incorrect job submission.

1832

"A String",

1833

],

1834

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1835

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

1840

"A String",

1841

],

1842

"fileUris": [ # 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.

1843

"A String",

1844

],

1845

"mainClass": "A 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.

1846

"archiveUris": [ # 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.

1847

"A String",

1848

],

1849

"mainJarFileUri": "A 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'

1850

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

"a_key": "A String",

},

},

"stepId": "A 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.

1855

"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.

1856

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

1857

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

1858

"a_key": "A String",

1859

},

1860

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1861

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

1866

"A String",

1867

],

1868

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1869

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.

"a_key": "A String",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

1887

"A String",

1888

],

1889

"pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.

1890

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

1891

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

1892

"a_key": "A String",

1893

},

1894

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1895

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

1900

"A String",

1901

],

1902

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1903

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

1917

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.

"a_key": "A String",

},

},

"labels": { # 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.

1922

"a_key": "A String",

1923

},

1924

"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.

1925

"args": [ # 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.

1926

"A String",

1927

],

1928

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1929

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

1934

"A String",

1935

],

1936

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

1937

"A String",

1938

],

1939

"mainClass": "A 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 jar_file_uris.

1940

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

1941

"A String",

1942

],

1943

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

1944

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

1949

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

1950

},

1951

"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.

1952

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

1953

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

1954

"A String",

1955

],

1956

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

1957

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"args": [ # 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.

1962

"A String",

1963

],

1964

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

1965

"A String",

1966

],

1967

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

1968

"A String",

1969

],

1970

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

1971

"A String",

1972

],

1973

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.

1978

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

1979

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

1980

"a_key": "A String",

1981

},

1982

"jarFileUris": [ # 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.

1983

"A String",

1984

],

1985

"queryList": { # A list of queries to run on a cluster. # A list of queries.

1986

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

2000

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

},

],

"id": "A String", # Required. The template id.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.

2007

}

2008

2009

requestId: string, Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

2010

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2017

2018

{ # This resource represents a long-running operation that is the result of a network API call.

2019

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

2020

"a_key": "", # Properties of the object. Contains field @type with type URL.

2021

},

2022

"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

2023

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

2024

"a_key": "", # Properties of the object. Contains field @type with type URL.

2025

},

2026

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

2027

"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

2028

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

2029

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

2030

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

2031

{

2032

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}</pre>

</div>

<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>

2041

<pre>Lists workflows that match the specified filter in the request.

2042

2043

Args:

2044

parent: string, Required. The "resource name" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region} (required)

2045

pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results.

2046

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

pageSize: integer, Optional. The maximum number of results to return in each response.

2051

2052

Returns:

2053

An object of the form:

2054

2055

{ # A response to a request to list workflow templates in a project.

2056

"nextPageToken": "A String", # Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListWorkflowTemplatesRequest</code>.

2057

"templates": [ # Output only. WorkflowTemplates list.

2058

{ # A Cloud Dataproc workflow template resource.

2059

"updateTime": "A String", # Output only. The time template was last updated.

2060

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

2061

"clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.

2062

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

2063

"a_key": "A String",

2064

},

2065

"zone": "A 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.

2066

},

2067

"managedCluster": { # Cluster that is managed by the workflow. # Optional. A cluster that is managed by the workflow.

2068

"clusterName": "A 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.

2069

"labels": { # 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.

2070

"a_key": "A String",

2071

},

2072

"config": { # The cluster config. # Required. The cluster configuration.

2073

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

2074

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.

2075

"optionalComponents": [ # The set of optional components to activate on the cluster.

2076

"A String",

2077

],

2078

"properties": { # 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:

2079

# capacity-scheduler: capacity-scheduler.xml

2080

# core: core-site.xml

2081

# distcp: distcp-default.xml

2082

# hdfs: hdfs-site.xml

2083

# hive: hive-site.xml

2084

# mapred: mapred-site.xml

2085

# pig: pig.properties

2086

# spark: spark-defaults.conf

2087

# yarn: yarn-site.xmlFor more information, see Cluster properties.

"a_key": "A String",

},

},

"configBucket": "A String", # Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).

2092

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

2093

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

2094

"networkUri": "A 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 for more information).A full URL, partial URI, or short name are valid. Examples:

2095

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

2096

# projects/[project_id]/regions/global/default

2097

# default

2098

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).

2099

"A String",

2100

],

2101

"serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:

2102

# roles/logging.logWriter

2103

# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com

2104

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

2105

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

2106

# projects/[project_id]/zones/[zone]

2107

# us-central1-f

2108

"subnetworkUri": "A 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:

2109

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

2110

# projects/[project_id]/regions/us-east1/subnetworks/sub0

2111

# sub0

2112

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

2113

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

2114

# https://www.googleapis.com/auth/devstorage.read_write

2115

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

2116

# https://www.googleapis.com/auth/bigquery

2117

# https://www.googleapis.com/auth/bigtable.admin.table

2118

# https://www.googleapis.com/auth/bigtable.data

2119

# https://www.googleapis.com/auth/devstorage.full_control

2120

"A String",

2121

],

2122

"metadata": { # 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)).

"a_key": "A String",

},

},

"workerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

2127

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

2128

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

2129

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2130

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2131

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2132

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

2133

"A String",

2134

],

2135

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

2136

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

2137

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

2138

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

2139

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

2140

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2141

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2142

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2143

},

2144

],

2145

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

2146

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

2147

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

2148

},

2149

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

2150

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

2151

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

2152

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

2153

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

2154

},

2155

},

2156

"initializationActions": [ # 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):

2157

# ROLE=$(curl -H Metadata-Flavor:Google

2158

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

2159

# if [[ "${ROLE}" == 'Master' ]]; then

2160

# ... master specific actions ...

2161

# else

2162

# ... worker specific actions ...

2163

# fi

2164

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

2165

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.

2166

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

2167

},

2168

],

2169

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

2170

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

2171

},

2172

"secondaryWorkerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

2173

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

2174

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

2175

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2176

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2177

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2178

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

2179

"A String",

2180

],

2181

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

2182

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

2183

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

2184

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

2185

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

2186

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2187

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2188

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2189

},

2190

],

2191

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

2192

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

2193

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

2194

},

2195

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

2196

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

2197

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

2198

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

2199

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

2200

},

2201

},

2202

"masterConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

2203

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

2204

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

2205

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2206

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2207

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2208

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

2209

"A String",

2210

],

2211

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

2212

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

2213

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

2214

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

2215

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

2216

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2217

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2218

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2219

},

2220

],

2221

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

2222

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

2223

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

2224

},

2225

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

2226

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

2227

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

2228

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

2229

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

2230

},

2231

},

2232

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

2233

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

2234

"truststorePasswordUri": "A 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 Dataproc.

2235

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

2236

"keyPasswordUri": "A 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 Dataproc.

2237

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.

2238

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

2239

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

2240

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

2241

"keystorePasswordUri": "A 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 Dataproc.

2242

"crossRealmTrustSharedPasswordUri": "A 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.

2243

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

2244

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

2245

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

2246

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

2247

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

},

},

},

},

},

"name": "A String", # Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

2254

"parameters": [ # Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

2255

{ # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

2256

"fields": [ # 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:

2257

# Values in maps can be referenced by key:

2258

# labels'key'

2259

# placement.clusterSelector.clusterLabels'key'

2260

# placement.managedCluster.labels'key'

2261

# placement.clusterSelector.clusterLabels'key'

2262

# jobs'step-id'.labels'key'

2263

# Jobs in the jobs list can be referenced by step-id:

2264

# jobs'step-id'.hadoopJob.mainJarFileUri

2265

# jobs'step-id'.hiveJob.queryFileUri

2266

# jobs'step-id'.pySparkJob.mainPythonFileUri

2267

# jobs'step-id'.hadoopJob.jarFileUris0

2268

# jobs'step-id'.hadoopJob.archiveUris0

2269

# jobs'step-id'.hadoopJob.fileUris0

2270

# jobs'step-id'.pySparkJob.pythonFileUris0

2271

# Items in repeated fields can be referenced by a zero-based index:

2272

# jobs'step-id'.sparkJob.args0

2273

# Other examples:

2274

# jobs'step-id'.hadoopJob.properties'key'

2275

# jobs'step-id'.hadoopJob.args0

2276

# jobs'step-id'.hiveJob.scriptVariables'key'

2277

# jobs'step-id'.hadoopJob.mainJarFileUri

2278

# 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:

2279

# placement.clusterSelector.clusterLabels

2280

# jobs'step-id'.sparkJob.args

2281

"A String",

2282

],

2283

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

2284

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

2285

"regexes": [ # 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).

"A String",

],

},

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

2290

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

},

"name": "A 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.

2296

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

2297

},

2298

],

2299

"labels": { # 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.

2300

"a_key": "A String",

2301

},

2302

"createTime": "A String", # Output only. The time template was created.

2303

"version": 42, # 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.

2304

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

2305

{ # A job executed by the workflow.

2306

"hadoopJob": { # A Cloud 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). # Job is a Hadoop job.

2307

"args": [ # 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 may occur that causes an incorrect job submission.

2308

"A String",

2309

],

2310

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2311

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

2316

"A String",

2317

],

2318

"fileUris": [ # 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.

2319

"A String",

2320

],

2321

"mainClass": "A 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.

2322

"archiveUris": [ # 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.

2323

"A String",

2324

],

2325

"mainJarFileUri": "A 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'

2326

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

"a_key": "A String",

},

},

"stepId": "A 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.

2331

"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.

2332

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

2333

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

2334

"a_key": "A String",

2335

},

2336

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2337

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

2342

"A String",

2343

],

2344

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2345

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.

"a_key": "A String",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

2363

"A String",

2364

],

2365

"pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.

2366

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

2367

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

2368

"a_key": "A String",

2369

},

2370

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2371

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

2376

"A String",

2377

],

2378

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2379

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

2393

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.

"a_key": "A String",

},

},

"labels": { # 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.

2398

"a_key": "A String",

2399

},

2400

"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.

2401

"args": [ # 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.

2402

"A String",

2403

],

2404

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2405

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

2410

"A String",

2411

],

2412

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

2413

"A String",

2414

],

2415

"mainClass": "A 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 jar_file_uris.

2416

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

2417

"A String",

2418

],

2419

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

2420

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

2425

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

2426

},

2427

"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.

2428

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

2429

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

2430

"A String",

2431

],

2432

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2433

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"args": [ # 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.

2438

"A String",

2439

],

2440

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

2441

"A String",

2442

],

2443

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

2444

"A String",

2445

],

2446

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

2447

"A String",

2448

],

2449

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.

2454

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

2455

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

2456

"a_key": "A String",

2457

},

2458

"jarFileUris": [ # 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.

2459

"A String",

2460

],

2461

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2462

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

2476

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

},

],

"id": "A String", # Required. The template id.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.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2490

<pre>Retrieves the next page of results.

2491

2492

Args:

2493

previous_request: The request for the previous page. (required)

2494

previous_response: The response from the request for the previous page. (required)

2495

2496

Returns:

2497

A request object that you can call 'execute()' on to request the next

2498

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>

2504

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.

2505

2506

Args:

2507

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

2508

body: object, The request body. (required)

2509

The object takes the form of:

2510

2511

{ # Request message for SetIamPolicy method.

2512

"policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

# {

# "bindings": [

# {

# "role": "roles/owner",

2517

# "members": [

2518

# "user:mike@example.com",

2519

# "group:admins@example.com",

2520

# "domain:google.com",

2521

# "serviceAccount:my-other-app@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/viewer",

2526

# "members": ["user:sean@example.com"]

# }

# ]

# }

# YAML Example

# bindings:

# - members:

# - user:mike@example.com

2534

# - group:admins@example.com

2535

# - domain:google.com

2536

# - serviceAccount:my-other-app@appspot.gserviceaccount.com

2537

# role: roles/owner

2538

# - members:

2539

# - user:sean@example.com

2540

# role: roles/viewer

2541

# For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).

2542

"bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.

2543

{ # Associates members with a role.

2544

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

2545

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

2546

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

2547

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2548

# user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .

2549

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

2550

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

2551

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

2552

"A String",

2553

],

2554

"condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.

2555

# title: "User account presence"

2556

# description: "Determines whether the request has a user account"

2557

# expression: "size(request.user) > 0"

2558

"location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

2559

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.

2560

"description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

2561

"title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

},

},

],

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

2566

"version": 42, # Deprecated.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2577

2578

{ # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example

# {

# "bindings": [

# {

# "role": "roles/owner",

2583

# "members": [

2584

# "user:mike@example.com",

2585

# "group:admins@example.com",

2586

# "domain:google.com",

2587

# "serviceAccount:my-other-app@appspot.gserviceaccount.com"

# ]

# },

# {

# "role": "roles/viewer",

2592

# "members": ["user:sean@example.com"]

# }

# ]

# }

# YAML Example

# bindings:

# - members:

# - user:mike@example.com

2600

# - group:admins@example.com

2601

# - domain:google.com

2602

# - serviceAccount:my-other-app@appspot.gserviceaccount.com

2603

# role: roles/owner

2604

# - members:

2605

# - user:sean@example.com

2606

# role: roles/viewer

2607

# For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).

2608

"bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.

2609

{ # Associates members with a role.

2610

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

2611

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

2612

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

2613

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

2614

# user:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com .

2615

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

2616

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

2617

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

2618

"A String",

2619

],

2620

"condition": { # Represents an expression text. Example: # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.

2621

# title: "User account presence"

2622

# description: "Determines whether the request has a user account"

2623

# expression: "size(request.user) > 0"

2624

"location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

2625

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.

2626

"description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

2627

"title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

},

},

],

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.

2632

"version": 42, # Deprecated.

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>

2638

<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

2639

2640

Args:

2641

resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)

2642

body: object, The request body. (required)

2643

The object takes the form of:

2644

2645

{ # Request message for TestIamPermissions method.

2646

"permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2658

2659

{ # Response message for TestIamPermissions method.

2660

"permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.

"A String",

],

}</pre>

</div>

<code class="details" id="update">update(name, body, x__xgafv=None)</code>

2668

<pre>Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

2669

2670

Args:

2671

name: string, Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id} (required)

2672

body: object, The request body. (required)

2673

The object takes the form of:

2674

2675

{ # A Cloud Dataproc workflow template resource.

2676

"updateTime": "A String", # Output only. The time template was last updated.

2677

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

2678

"clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.

2679

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

2680

"a_key": "A String",

2681

},

2682

"zone": "A 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.

2683

},

2684

"managedCluster": { # Cluster that is managed by the workflow. # Optional. A cluster that is managed by the workflow.

2685

"clusterName": "A 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.

2686

"labels": { # 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.

2687

"a_key": "A String",

2688

},

2689

"config": { # The cluster config. # Required. The cluster configuration.

2690

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

2691

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.

2692

"optionalComponents": [ # The set of optional components to activate on the cluster.

2693

"A String",

2694

],

2695

"properties": { # 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:

2696

# capacity-scheduler: capacity-scheduler.xml

2697

# core: core-site.xml

2698

# distcp: distcp-default.xml

2699

# hdfs: hdfs-site.xml

2700

# hive: hive-site.xml

2701

# mapred: mapred-site.xml

2702

# pig: pig.properties

2703

# spark: spark-defaults.conf

2704

# yarn: yarn-site.xmlFor more information, see Cluster properties.

"a_key": "A String",

},

},

"configBucket": "A String", # Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).

2709

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

2710

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

2711

"networkUri": "A 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 for more information).A full URL, partial URI, or short name are valid. Examples:

2712

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

2713

# projects/[project_id]/regions/global/default

2714

# default

2715

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).

2716

"A String",

2717

],

2718

"serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:

2719

# roles/logging.logWriter

2720

# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com

2721

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

2722

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

2723

# projects/[project_id]/zones/[zone]

2724

# us-central1-f

2725

"subnetworkUri": "A 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:

2726

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

2727

# projects/[project_id]/regions/us-east1/subnetworks/sub0

2728

# sub0

2729

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

2730

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

2731

# https://www.googleapis.com/auth/devstorage.read_write

2732

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

2733

# https://www.googleapis.com/auth/bigquery

2734

# https://www.googleapis.com/auth/bigtable.admin.table

2735

# https://www.googleapis.com/auth/bigtable.data

2736

# https://www.googleapis.com/auth/devstorage.full_control

2737

"A String",

2738

],

2739

"metadata": { # 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)).

"a_key": "A String",

},

},

"workerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

2744

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

2745

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

2746

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2747

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2748

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2749

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

2750

"A String",

2751

],

2752

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

2753

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

2754

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

2755

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

2756

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

2757

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2758

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2759

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2760

},

2761

],

2762

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

2763

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

2764

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

2765

},

2766

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

2767

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

2768

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

2769

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

2770

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

2771

},

2772

},

2773

"initializationActions": [ # 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):

2774

# ROLE=$(curl -H Metadata-Flavor:Google

2775

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

2776

# if [[ "${ROLE}" == 'Master' ]]; then

2777

# ... master specific actions ...

2778

# else

2779

# ... worker specific actions ...

2780

# fi

2781

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

2782

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.

2783

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

2784

},

2785

],

2786

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

2787

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

2788

},

2789

"secondaryWorkerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

2790

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

2791

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

2792

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2793

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2794

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2795

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

2796

"A String",

2797

],

2798

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

2799

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

2800

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

2801

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

2802

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

2803

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2804

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2805

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2806

},

2807

],

2808

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

2809

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

2810

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

2811

},

2812

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

2813

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

2814

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

2815

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

2816

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

2817

},

2818

},

2819

"masterConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

2820

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

2821

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

2822

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2823

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

2824

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2825

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

2826

"A String",

2827

],

2828

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

2829

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

2830

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

2831

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

2832

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

2833

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2834

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

2835

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2836

},

2837

],

2838

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

2839

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

2840

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

2841

},

2842

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

2843

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

2844

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

2845

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

2846

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

2847

},

2848

},

2849

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

2850

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

2851

"truststorePasswordUri": "A 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 Dataproc.

2852

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

2853

"keyPasswordUri": "A 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 Dataproc.

2854

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.

2855

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

2856

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

2857

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

2858

"keystorePasswordUri": "A 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 Dataproc.

2859

"crossRealmTrustSharedPasswordUri": "A 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.

2860

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

2861

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

2862

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

2863

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

2864

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

},

},

},

},

},

"name": "A String", # Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

2871

"parameters": [ # Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

2872

{ # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

2873

"fields": [ # 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:

2874

# Values in maps can be referenced by key:

2875

# labels'key'

2876

# placement.clusterSelector.clusterLabels'key'

2877

# placement.managedCluster.labels'key'

2878

# placement.clusterSelector.clusterLabels'key'

2879

# jobs'step-id'.labels'key'

2880

# Jobs in the jobs list can be referenced by step-id:

2881

# jobs'step-id'.hadoopJob.mainJarFileUri

2882

# jobs'step-id'.hiveJob.queryFileUri

2883

# jobs'step-id'.pySparkJob.mainPythonFileUri

2884

# jobs'step-id'.hadoopJob.jarFileUris0

2885

# jobs'step-id'.hadoopJob.archiveUris0

2886

# jobs'step-id'.hadoopJob.fileUris0

2887

# jobs'step-id'.pySparkJob.pythonFileUris0

2888

# Items in repeated fields can be referenced by a zero-based index:

2889

# jobs'step-id'.sparkJob.args0

2890

# Other examples:

2891

# jobs'step-id'.hadoopJob.properties'key'

2892

# jobs'step-id'.hadoopJob.args0

2893

# jobs'step-id'.hiveJob.scriptVariables'key'

2894

# jobs'step-id'.hadoopJob.mainJarFileUri

2895

# 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:

2896

# placement.clusterSelector.clusterLabels

2897

# jobs'step-id'.sparkJob.args

2898

"A String",

2899

],

2900

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

2901

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

2902

"regexes": [ # 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).

"A String",

],

},

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

2907

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

},

"name": "A 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.

2913

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

2914

},

2915

],

2916

"labels": { # 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.

2917

"a_key": "A String",

2918

},

2919

"createTime": "A String", # Output only. The time template was created.

2920

"version": 42, # 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.

2921

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

2922

{ # A job executed by the workflow.

2923

"hadoopJob": { # A Cloud 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). # Job is a Hadoop job.

2924

"args": [ # 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 may occur that causes an incorrect job submission.

2925

"A String",

2926

],

2927

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2928

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

2933

"A String",

2934

],

2935

"fileUris": [ # 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.

2936

"A String",

2937

],

2938

"mainClass": "A 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.

2939

"archiveUris": [ # 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.

2940

"A String",

2941

],

2942

"mainJarFileUri": "A 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'

2943

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

"a_key": "A String",

},

},

"stepId": "A 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.

2948

"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.

2949

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

2950

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

2951

"a_key": "A String",

2952

},

2953

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2954

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

2959

"A String",

2960

],

2961

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2962

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.

"a_key": "A String",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

2980

"A String",

2981

],

2982

"pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.

2983

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

2984

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

2985

"a_key": "A String",

2986

},

2987

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

2988

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

2993

"A String",

2994

],

2995

"queryList": { # A list of queries to run on a cluster. # A list of queries.

2996

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

3010

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.

"a_key": "A String",

},

},

"labels": { # 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.

3015

"a_key": "A String",

3016

},

3017

"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.

3018

"args": [ # 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.

3019

"A String",

3020

],

3021

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3022

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

3027

"A String",

3028

],

3029

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

3030

"A String",

3031

],

3032

"mainClass": "A 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 jar_file_uris.

3033

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

3034

"A String",

3035

],

3036

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

3037

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

3042

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

3043

},

3044

"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.

3045

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

3046

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

3047

"A String",

3048

],

3049

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3050

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"args": [ # 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.

3055

"A String",

3056

],

3057

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

3058

"A String",

3059

],

3060

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

3061

"A String",

3062

],

3063

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

3064

"A String",

3065

],

3066

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.

3071

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

3072

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

3073

"a_key": "A String",

3074

},

3075

"jarFileUris": [ # 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.

3076

"A String",

3077

],

3078

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3079

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

3093

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

},

],

"id": "A String", # Required. The template id.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.

3100

}

3101

3102

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3109

3110

{ # A Cloud Dataproc workflow template resource.

3111

"updateTime": "A String", # Output only. The time template was last updated.

3112

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

3113

"clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.

3114

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

3115

"a_key": "A String",

3116

},

3117

"zone": "A 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.

3118

},

3119

"managedCluster": { # Cluster that is managed by the workflow. # Optional. A cluster that is managed by the workflow.

3120

"clusterName": "A 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.

3121

"labels": { # 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.

3122

"a_key": "A String",

3123

},

3124

"config": { # The cluster config. # Required. The cluster configuration.

3125

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

3126

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.

3127

"optionalComponents": [ # The set of optional components to activate on the cluster.

3128

"A String",

3129

],

3130

"properties": { # 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:

3131

# capacity-scheduler: capacity-scheduler.xml

3132

# core: core-site.xml

3133

# distcp: distcp-default.xml

3134

# hdfs: hdfs-site.xml

3135

# hive: hive-site.xml

3136

# mapred: mapred-site.xml

3137

# pig: pig.properties

3138

# spark: spark-defaults.conf

3139

# yarn: yarn-site.xmlFor more information, see Cluster properties.

"a_key": "A String",

},

},

"configBucket": "A String", # Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).

3144

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

3145

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

3146

"networkUri": "A 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 for more information).A full URL, partial URI, or short name are valid. Examples:

3147

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

3148

# projects/[project_id]/regions/global/default

3149

# default

3150

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).

3151

"A String",

3152

],

3153

"serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:

3154

# roles/logging.logWriter

3155

# roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com

3156

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

3157

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

3158

# projects/[project_id]/zones/[zone]

3159

# us-central1-f

3160

"subnetworkUri": "A 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:

3161

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

3162

# projects/[project_id]/regions/us-east1/subnetworks/sub0

3163

# sub0

3164

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

3165

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

3166

# https://www.googleapis.com/auth/devstorage.read_write

3167

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

3168

# https://www.googleapis.com/auth/bigquery

3169

# https://www.googleapis.com/auth/bigtable.admin.table

3170

# https://www.googleapis.com/auth/bigtable.data

3171

# https://www.googleapis.com/auth/devstorage.full_control

3172

"A String",

3173

],

3174

"metadata": { # 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)).

"a_key": "A String",

},

},

"workerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

3179

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

3180

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

3181

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3182

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3183

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

3184

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

3185

"A String",

3186

],

3187

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

3188

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

3189

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

3190

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

3191

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

3192

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3193

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3194

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

3195

},

3196

],

3197

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

3198

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

3199

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

3200

},

3201

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

3202

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

3203

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

3204

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

3205

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

3206

},

3207

},

3208

"initializationActions": [ # 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):

3209

# ROLE=$(curl -H Metadata-Flavor:Google

3210

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

3211

# if [[ "${ROLE}" == 'Master' ]]; then

3212

# ... master specific actions ...

3213

# else

3214

# ... worker specific actions ...

3215

# fi

3216

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

3217

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.

3218

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

3219

},

3220

],

3221

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

3222

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

3223

},

3224

"secondaryWorkerConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

3225

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

3226

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

3227

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3228

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3229

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

3230

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

3231

"A String",

3232

],

3233

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

3234

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

3235

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

3236

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

3237

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

3238

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3239

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3240

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

3241

},

3242

],

3243

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

3244

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

3245

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

3246

},

3247

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

3248

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

3249

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

3250

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

3251

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

3252

},

3253

},

3254

"masterConfig": { # Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

3255

"isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.

3256

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

3257

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3258

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3259

# n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.

3260

"instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.

3261

"A String",

3262

],

3263

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.

3264

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.

3265

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.

3266

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

3267

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:

3268

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3269

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3270

# nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

3271

},

3272

],

3273

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

3274

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

3275

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

3276

},

3277

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

3278

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

3279

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (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.

3280

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

3281

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

3282

},

3283

},

3284

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

3285

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

3286

"truststorePasswordUri": "A 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 Dataproc.

3287

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

3288

"keyPasswordUri": "A 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 Dataproc.

3289

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.

3290

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

3291

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

3292

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

3293

"keystorePasswordUri": "A 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 Dataproc.

3294

"crossRealmTrustSharedPasswordUri": "A 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.

3295

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

3296

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

3297

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

3298

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

3299

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

},

},

},

},

},

"name": "A String", # Output only. The "resource name" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

3306

"parameters": [ # Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

3307

{ # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)

3308

"fields": [ # 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:

3309

# Values in maps can be referenced by key:

3310

# labels'key'

3311

# placement.clusterSelector.clusterLabels'key'

3312

# placement.managedCluster.labels'key'

3313

# placement.clusterSelector.clusterLabels'key'

3314

# jobs'step-id'.labels'key'

3315

# Jobs in the jobs list can be referenced by step-id:

3316

# jobs'step-id'.hadoopJob.mainJarFileUri

3317

# jobs'step-id'.hiveJob.queryFileUri

3318

# jobs'step-id'.pySparkJob.mainPythonFileUri

3319

# jobs'step-id'.hadoopJob.jarFileUris0

3320

# jobs'step-id'.hadoopJob.archiveUris0

3321

# jobs'step-id'.hadoopJob.fileUris0

3322

# jobs'step-id'.pySparkJob.pythonFileUris0

3323

# Items in repeated fields can be referenced by a zero-based index:

3324

# jobs'step-id'.sparkJob.args0

3325

# Other examples:

3326

# jobs'step-id'.hadoopJob.properties'key'

3327

# jobs'step-id'.hadoopJob.args0

3328

# jobs'step-id'.hiveJob.scriptVariables'key'

3329

# jobs'step-id'.hadoopJob.mainJarFileUri

3330

# 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:

3331

# placement.clusterSelector.clusterLabels

3332

# jobs'step-id'.sparkJob.args

3333

"A String",

3334

],

3335

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

3336

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

3337

"regexes": [ # 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).

"A String",

],

},

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

3342

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

},

"name": "A 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.

3348

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

3349

},

3350

],

3351

"labels": { # 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.

3352

"a_key": "A String",

3353

},

3354

"createTime": "A String", # Output only. The time template was created.

3355

"version": 42, # 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.

3356

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

3357

{ # A job executed by the workflow.

3358

"hadoopJob": { # A Cloud 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). # Job is a Hadoop job.

3359

"args": [ # 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 may occur that causes an incorrect job submission.

3360

"A String",

3361

],

3362

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3363

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

3368

"A String",

3369

],

3370

"fileUris": [ # 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.

3371

"A String",

3372

],

3373

"mainClass": "A 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.

3374

"archiveUris": [ # 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.

3375

"A String",

3376

],

3377

"mainJarFileUri": "A 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'

3378

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

"a_key": "A String",

},

},

"stepId": "A 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.

3383

"sparkSqlJob": { # A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Job is a SparkSql job.

3384

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

3385

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

3386

"a_key": "A String",

3387

},

3388

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3389

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

3394

"A String",

3395

],

3396

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3397

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.

"a_key": "A String",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

3415

"A String",

3416

],

3417

"pigJob": { # A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Job is a Pig job.

3418

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

3419

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

3420

"a_key": "A String",

3421

},

3422

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3423

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.

3428

"A String",

3429

],

3430

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3431

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

3445

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.

"a_key": "A String",

},

},

"labels": { # 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.

3450

"a_key": "A String",

3451

},

3452

"sparkJob": { # A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Job is a Spark job.

3453

"args": [ # 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.

3454

"A String",

3455

],

3456

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3457

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

3462

"A String",

3463

],

3464

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

3465

"A String",

3466

],

3467

"mainClass": "A 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 jar_file_uris.

3468

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.

3469

"A String",

3470

],

3471

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

3472

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

3477

"maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.

3478

},

3479

"pysparkJob": { # A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Job is a Pyspark job.

3480

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

3481

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

3482

"A String",

3483

],

3484

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3485

"driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'

"a_key": "A String",

},

},

"args": [ # 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.

3490

"A String",

3491

],

3492

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

3493

"A String",

3494

],

3495

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

3496

"A String",

3497

],

3498

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

3499

"A String",

3500

],

3501

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

"a_key": "A String",

},

},

"hiveJob": { # A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Job is a Hive job.

3506

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

3507

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

3508

"a_key": "A String",

3509

},

3510

"jarFileUris": [ # 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.

3511

"A String",

3512

],

3513

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3514

"queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:

# "hiveJob": {

# "queryList": {

# "queries": [

# "query1",

# "query2",

# "query3;query4",

# ]

# }

# }

"A String",

],

},

"continueOnFailure": True or False, # 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.

3528

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.

"a_key": "A String",

},

},

},

],

"id": "A String", # Required. The template id.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.

}</pre>

</div>

</body></html>