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

2020-05-01 07:42:23 -0700

[diff] [blame]

78

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

90

<code><a href="#instantiate">instantiate(name, body=None, 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 (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

<code><a href="#instantiateInline">instantiateInline(parent, body=None, 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 (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

95

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

96

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

112

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

<pre>Creates new workflow template.

114

115

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

116

parent: string, Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

117

For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region}

118

For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} (required)

119

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

120

The object takes the form of:

121

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

122

{ # A Dataproc workflow template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

123

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

124

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

125

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

126

{ # A job executed by the workflow.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

127

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

128

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

129

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

130

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

131

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

132

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

139

# ]

140

# }

141

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

143

],

144

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

145

"clientTags": [ # Optional. Presto client tags to attach to this query

146

"A String",

147

],

148

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

149

"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",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

154

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

155

},

156

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

157

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

158

"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.

159

},

160

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

161

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

162

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

167

"a_key": "A String",

168

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

169

"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.

170

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

171

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

172

"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",

],

},

"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.

186

"A String",

187

],

188

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

189

"a_key": "A String",

190

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

191

},

192

"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.

193

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

194

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

195

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

196

"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",

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

209

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

210

"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.

211

"A String",

212

],

213

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

214

"a_key": "A String",

215

},

216

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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",

},

},

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

221

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

222

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

223

"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.

224

"a_key": "A String",

225

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

226

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

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

228

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

229

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

236

# ]

237

# }

238

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

239

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

240

],

241

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

242

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

243

"a_key": "A String",

244

},

245

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

246

"A String",

247

],

248

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

249

"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",

},

},

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

"a_key": "A String",

},

},

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

258

"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.

259

"A String",

260

],

261

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

262

"A String",

263

],

264

"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.

265

"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.

266

"A String",

267

],

268

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

269

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

270

"A String",

271

],

272

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

273

"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",

},

},

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

278

"a_key": "A String",

279

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

280

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

281

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

282

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

283

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

284

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

285

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

286

"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'

287

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

288

},

289

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

290

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

291

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

292

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

293

"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.

294

"A String",

295

],

296

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

297

"A String",

298

],

299

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

300

"A String",

301

],

302

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

303

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

304

"A String",

305

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

306

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

307

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

308

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

309

"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'

310

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

311

},

312

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

313

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

314

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

315

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

316

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

317

"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.

318

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

319

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

320

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

321

"A String",

322

],

323

"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.

"A String",

],

},

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

328

"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.

329

"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.

330

"A String",

331

],

332

"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'

333

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

334

"A String",

335

],

336

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

337

"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'

338

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

339

},

340

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

341

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

342

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

343

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

344

"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.

345

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

346

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

347

"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.

348

"A String",

349

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

350

},

351

},

352

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

353

"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.

354

"a_key": "A String",

355

},

356

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

357

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

358

"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.

359

"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.

360

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

"a_key": "A String",

},

},

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

365

"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.

366

"a_key": "A String",

367

},

368

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

369

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

370

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

371

},

372

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

373

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

374

"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.

375

"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.

376

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

377

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

378

"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.

379

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

380

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

381

"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.

382

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

383

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

384

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

385

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

386

"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.

387

"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.

388

"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.

389

},

390

},

391

"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):

392

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

393

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

394

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

395

# ... master specific actions ...

396

# else

397

# ... worker specific actions ...

398

# fi

399

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

400

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

401

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

402

},

403

],

404

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

405

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

406

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

407

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

408

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

409

},

410

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

411

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

412

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

413

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

414

"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.

415

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

416

"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).

417

},

418

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

419

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

420

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

421

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

422

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

423

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

424

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

425

# projects/[project_id]/global/images/[image-id]

426

# image-idImage family examples. Dataproc will use the most recent image from the family:

427

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

428

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

429

"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.

430

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

431

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

432

},

433

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

434

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

435

"A String",

436

],

437

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

438

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

439

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

440

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

441

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

442

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

443

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

444

},

445

],

446

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

447

},

448

"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.

449

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

450

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

451

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

452

# sub0

453

"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 (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

454

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

455

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

456

# default

457

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

458

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

459

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

460

# us-central1-f

461

"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)).

462

"a_key": "A String",

463

},

464

"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.

465

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

466

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

467

"values": [ # Optional. Corresponds to the label values of reservation resource.

468

"A String",

469

],

470

"consumeReservationType": "A String", # Optional. Type of reservation to consume

471

},

472

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

473

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

474

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

475

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

476

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

477

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

478

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

479

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

480

"A String",

481

],

482

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

483

"A String",

484

],

485

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

486

},

487

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

488

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

489

"A String",

490

],

491

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

492

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

493

# capacity-scheduler: capacity-scheduler.xml

494

# core: core-site.xml

495

# distcp: distcp-default.xml

496

# hdfs: hdfs-site.xml

497

# hive: hive-site.xml

498

# mapred: mapred-site.xml

499

# pig: pig.properties

500

# spark: spark-defaults.conf

501

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

"a_key": "A String",

},

},

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

506

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

507

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

508

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

509

},

510

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

511

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

512

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

513

"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.

514

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

515

"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).

516

},

517

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

518

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

519

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

520

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

521

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

522

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

523

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

524

# projects/[project_id]/global/images/[image-id]

525

# image-idImage family examples. Dataproc will use the most recent image from the family:

526

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

527

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

528

"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.

529

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

530

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

531

},

532

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

533

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

534

"A String",

535

],

536

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

537

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

538

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

539

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

540

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

541

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

542

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

543

},

544

],

545

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

546

},

547

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

548

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

549

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

550

"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.

551

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

552

"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).

553

},

554

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

555

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

556

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

557

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

558

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

559

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

560

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

561

# projects/[project_id]/global/images/[image-id]

562

# image-idImage family examples. Dataproc will use the most recent image from the family:

563

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

564

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

565

"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.

566

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

567

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

568

},

569

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

570

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

571

"A String",

572

],

573

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

574

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

575

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

576

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

577

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

578

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

579

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

580

},

581

],

582

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

583

},

584

},

585

"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.

586

},

587

},

588

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

589

"name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

590

# For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

591

# For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

592

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

593

{ # 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)

594

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

595

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

596

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

"A String",

],

},

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

601

"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",

],

},

},

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

607

# Values in maps can be referenced by key:

608

# labels'key'

609

# placement.clusterSelector.clusterLabels'key'

610

# placement.managedCluster.labels'key'

611

# placement.clusterSelector.clusterLabels'key'

612

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

613

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

614

# jobs'step-id'.hadoopJob.mainJarFileUri

615

# jobs'step-id'.hiveJob.queryFileUri

616

# jobs'step-id'.pySparkJob.mainPythonFileUri

617

# jobs'step-id'.hadoopJob.jarFileUris0

618

# jobs'step-id'.hadoopJob.archiveUris0

619

# jobs'step-id'.hadoopJob.fileUris0

620

# jobs'step-id'.pySparkJob.pythonFileUris0

621

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

622

# jobs'step-id'.sparkJob.args0

623

# Other examples:

624

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

625

# jobs'step-id'.hadoopJob.args0

626

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

627

# jobs'step-id'.hadoopJob.mainJarFileUri

628

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

629

# placement.clusterSelector.clusterLabels

630

# jobs'step-id'.sparkJob.args

631

"A String",

632

],

633

"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.

634

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

635

},

636

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

637

}

638

639

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

646

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

647

{ # A Dataproc workflow template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

648

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

649

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

650

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

651

{ # A job executed by the workflow.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

652

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

653

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

654

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

655

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

656

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

657

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

664

# ]

665

# }

666

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

667

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

668

],

669

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

670

"clientTags": [ # Optional. Presto client tags to attach to this query

671

"A String",

672

],

673

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

674

"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",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

679

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

680

},

681

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

682

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

683

"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.

684

},

685

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

686

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

687

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

692

"a_key": "A String",

693

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

694

"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.

695

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

696

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

697

"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",

],

},

"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.

711

"A String",

712

],

713

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

714

"a_key": "A String",

715

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

716

},

717

"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.

718

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

719

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

720

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

721

"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",

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

734

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

735

"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.

736

"A String",

737

],

738

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

739

"a_key": "A String",

740

},

741

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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",

},

},

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

746

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

747

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

748

"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.

749

"a_key": "A String",

750

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

751

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

752

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

753

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

754

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

761

# ]

762

# }

763

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

764

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

765

],

766

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

767

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

768

"a_key": "A String",

769

},

770

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

771

"A String",

772

],

773

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

774

"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",

},

},

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

"a_key": "A String",

},

},

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

783

"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.

784

"A String",

785

],

786

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

787

"A String",

788

],

789

"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.

790

"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.

791

"A String",

792

],

793

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

794

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

795

"A String",

796

],

797

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

798

"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",

},

},

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

803

"a_key": "A String",

804

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

805

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

806

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

807

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

808

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

809

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

810

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

811

"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'

812

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

813

},

814

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

815

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

816

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

817

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

818

"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.

819

"A String",

820

],

821

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

822

"A String",

823

],

824

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

825

"A String",

826

],

827

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

828

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

829

"A String",

830

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

831

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

832

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

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'

835

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

836

},

837

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

838

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

839

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

840

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

841

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

842

"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.

843

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

844

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

845

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

846

"A String",

847

],

848

"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.

"A String",

],

},

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

853

"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.

854

"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.

855

"A String",

856

],

857

"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'

858

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

859

"A String",

860

],

861

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

862

"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'

863

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

864

},

865

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

866

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

867

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

868

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

869

"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.

870

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

871

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

872

"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.

873

"A String",

874

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

875

},

876

},

877

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

878

"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.

879

"a_key": "A String",

880

},

881

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

882

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

883

"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.

884

"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.

885

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

"a_key": "A String",

},

},

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

890

"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.

891

"a_key": "A String",

892

},

893

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

894

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

895

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

896

},

897

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

898

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

899

"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.

900

"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.

901

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

902

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

903

"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.

904

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

905

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

906

"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.

907

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

908

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

909

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

910

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

911

"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.

912

"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.

913

"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.

914

},

915

},

916

"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):

917

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

918

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

919

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

920

# ... master specific actions ...

921

# else

922

# ... worker specific actions ...

923

# fi

924

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

925

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

926

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

927

},

928

],

929

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

930

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

931

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

932

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

933

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

934

},

935

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

936

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

937

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

938

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

939

"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.

940

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

941

"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).

942

},

943

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

944

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

945

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

946

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

947

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

948

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

949

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

950

# projects/[project_id]/global/images/[image-id]

951

# image-idImage family examples. Dataproc will use the most recent image from the family:

952

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

953

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

954

"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.

955

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

956

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

957

},

958

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

959

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

960

"A String",

961

],

962

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

963

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

964

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

965

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

966

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

967

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

968

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

969

},

970

],

971

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

972

},

973

"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.

974

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

975

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

976

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

977

# sub0

978

"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 (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

979

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

980

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

981

# default

982

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

983

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

984

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

985

# us-central1-f

986

"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)).

987

"a_key": "A String",

988

},

989

"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.

990

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

991

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

992

"values": [ # Optional. Corresponds to the label values of reservation resource.

993

"A String",

994

],

995

"consumeReservationType": "A String", # Optional. Type of reservation to consume

996

},

997

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

998

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

999

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

1000

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

1001

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

1002

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

1003

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

1004

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

1005

"A String",

1006

],

1007

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

1008

"A String",

1009

],

1010

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

1011

},

1012

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

1013

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

1014

"A String",

1015

],

1016

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

1017

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

1018

# capacity-scheduler: capacity-scheduler.xml

1019

# core: core-site.xml

1020

# distcp: distcp-default.xml

1021

# hdfs: hdfs-site.xml

1022

# hive: hive-site.xml

1023

# mapred: mapred-site.xml

1024

# pig: pig.properties

1025

# spark: spark-defaults.conf

1026

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

"a_key": "A String",

},

},

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

1031

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

1032

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

1033

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

1034

},

1035

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

1036

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1037

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

1038

"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.

1039

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

1040

"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).

1041

},

1042

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1043

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

1044

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

1045

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

1046

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1047

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1048

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1049

# projects/[project_id]/global/images/[image-id]

1050

# image-idImage family examples. Dataproc will use the most recent image from the family:

1051

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1052

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

1053

"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.

1054

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

1055

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

1056

},

1057

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

1058

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

1059

"A String",

1060

],

1061

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1062

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1063

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1064

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

1065

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

1066

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1067

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

1068

},

1069

],

1070

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

1071

},

1072

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

1073

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1074

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

1075

"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.

1076

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

1077

"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).

1078

},

1079

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1080

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

1081

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

1082

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

1083

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1084

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1085

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1086

# projects/[project_id]/global/images/[image-id]

1087

# image-idImage family examples. Dataproc will use the most recent image from the family:

1088

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1089

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

1090

"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.

1091

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

1092

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

1093

},

1094

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

1095

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

1096

"A String",

1097

],

1098

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1099

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1100

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1101

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

1102

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

1103

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1104

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

1105

},

1106

],

1107

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

1108

},

1109

},

1110

"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.

1111

},

1112

},

1113

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

1114

"name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

1115

# For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

1116

# For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

1117

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

1118

{ # 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)

1119

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

1120

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

1121

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

"A String",

],

},

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

1126

"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",

],

},

},

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

1132

# Values in maps can be referenced by key:

1133

# labels'key'

1134

# placement.clusterSelector.clusterLabels'key'

1135

# placement.managedCluster.labels'key'

1136

# placement.clusterSelector.clusterLabels'key'

1137

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

1138

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

1139

# jobs'step-id'.hadoopJob.mainJarFileUri

1140

# jobs'step-id'.hiveJob.queryFileUri

1141

# jobs'step-id'.pySparkJob.mainPythonFileUri

1142

# jobs'step-id'.hadoopJob.jarFileUris0

1143

# jobs'step-id'.hadoopJob.archiveUris0

1144

# jobs'step-id'.hadoopJob.fileUris0

1145

# jobs'step-id'.pySparkJob.pythonFileUris0

1146

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

1147

# jobs'step-id'.sparkJob.args0

1148

# Other examples:

1149

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

1150

# jobs'step-id'.hadoopJob.args0

1151

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

1152

# jobs'step-id'.hadoopJob.mainJarFileUri

1153

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

1154

# placement.clusterSelector.clusterLabels

1155

# jobs'step-id'.sparkJob.args

1156

"A String",

1157

],

1158

"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.

1159

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

1160

},

1161

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

1167

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

1168

1169

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1170

name: string, Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

1171

For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

1172

For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1173

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.

1174

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1181

1182

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

1183

# service Foo {

1184

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

1185

# }

1186

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

}</pre>

</div>

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

1192

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

1193

1194

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1195

name: string, Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

1196

For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

1197

For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)

1198

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1199

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1206

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1207

{ # A Dataproc workflow template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1208

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1209

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1210

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1211

{ # A job executed by the workflow.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1212

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

1213

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

1214

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1215

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1216

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

1217

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1224

# ]

1225

# }

1226

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1227

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1228

],

1229

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1230

"clientTags": [ # Optional. Presto client tags to attach to this query

1231

"A String",

1232

],

1233

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

1234

"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",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

1239

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1240

},

1241

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1242

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

1243

"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.

1244

},

1245

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1246

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

1247

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

1252

"a_key": "A String",

1253

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1254

"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.

1255

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

1256

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

1257

"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",

],

},

"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.

1271

"A String",

1272

],

1273

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

1274

"a_key": "A String",

1275

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1276

},

1277

"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.

1278

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

1279

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1280

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

1281

"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",

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1294

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1295

"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.

1296

"A String",

1297

],

1298

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

1299

"a_key": "A String",

1300

},

1301

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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",

},

},

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

1306

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1307

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1308

"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.

1309

"a_key": "A String",

1310

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1311

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1312

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

1313

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

1314

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1321

# ]

1322

# }

1323

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1324

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1325

],

1326

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1327

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

1328

"a_key": "A String",

1329

},

1330

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

1331

"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",

},

},

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

"a_key": "A String",

},

},

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

1343

"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.

1344

"A String",

1345

],

1346

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

1347

"A String",

1348

],

1349

"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.

1350

"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.

1351

"A String",

1352

],

1353

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

1354

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

1355

"A String",

1356

],

1357

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

1358

"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",

},

},

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

1363

"a_key": "A String",

1364

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1365

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1366

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

1367

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

1368

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1369

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1370

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

1371

"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'

1372

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1373

},

1374

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1375

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

1376

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1377

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1378

"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.

1379

"A String",

1380

],

1381

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

1382

"A String",

1383

],

1384

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

1385

"A String",

1386

],

1387

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

1388

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

1389

"A String",

1390

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1391

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1392

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

1393

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

1394

"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'

1395

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1396

},

1397

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1398

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

1399

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1400

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1401

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

1402

"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.

1403

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1404

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1405

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

1406

"A String",

1407

],

1408

"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.

"A String",

],

},

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

1413

"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.

1414

"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.

1415

"A String",

1416

],

1417

"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'

1418

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

1419

"A String",

1420

],

1421

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

1422

"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'

1423

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1424

},

1425

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1426

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

1427

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1428

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1429

"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.

1430

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1431

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1432

"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.

1433

"A String",

1434

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1435

},

1436

},

1437

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1438

"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.

1439

"a_key": "A String",

1440

},

1441

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1442

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

1443

"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.

1444

"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.

1445

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

"a_key": "A String",

},

},

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

1450

"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.

1451

"a_key": "A String",

1452

},

1453

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

1454

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

1455

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

1456

},

1457

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

1458

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

1459

"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.

1460

"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.

1461

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

1462

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

1463

"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.

1464

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

1465

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

1466

"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.

1467

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

1468

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

1469

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

1470

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

1471

"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.

1472

"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.

1473

"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.

1474

},

1475

},

1476

"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):

1477

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

1478

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

1479

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

1480

# ... master specific actions ...

1481

# else

1482

# ... worker specific actions ...

1483

# fi

1484

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

1485

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

1486

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

1487

},

1488

],

1489

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

1490

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1491

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1492

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1493

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

1494

},

1495

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

1496

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

1497

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1498

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

1499

"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.

1500

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

1501

"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).

1502

},

1503

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1504

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

1505

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

1506

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

1507

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1508

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1509

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1510

# projects/[project_id]/global/images/[image-id]

1511

# image-idImage family examples. Dataproc will use the most recent image from the family:

1512

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1513

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

1514

"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.

1515

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

1516

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

1517

},

1518

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

1519

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

1520

"A String",

1521

],

1522

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1523

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1524

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1525

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

1526

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

1527

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1528

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

1529

},

1530

],

1531

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

1532

},

1533

"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.

1534

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

1535

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

1536

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

1537

# sub0

1538

"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 (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

1539

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

1540

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

1541

# default

1542

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

1543

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

1544

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

1545

# us-central1-f

1546

"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)).

1547

"a_key": "A String",

1548

},

1549

"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.

1550

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

1551

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

1552

"values": [ # Optional. Corresponds to the label values of reservation resource.

1553

"A String",

1554

],

1555

"consumeReservationType": "A String", # Optional. Type of reservation to consume

1556

},

1557

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

1558

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

1559

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

1560

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

1561

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

1562

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

1563

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

1564

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

1565

"A String",

1566

],

1567

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

1568

"A String",

1569

],

1570

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

1571

},

1572

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

1573

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

1574

"A String",

1575

],

1576

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

1577

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

1578

# capacity-scheduler: capacity-scheduler.xml

1579

# core: core-site.xml

1580

# distcp: distcp-default.xml

1581

# hdfs: hdfs-site.xml

1582

# hive: hive-site.xml

1583

# mapred: mapred-site.xml

1584

# pig: pig.properties

1585

# spark: spark-defaults.conf

1586

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

"a_key": "A String",

},

},

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

1591

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

1592

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

1593

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

1594

},

1595

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

1596

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1597

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

1598

"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.

1599

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

1600

"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).

1601

},

1602

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1603

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

1604

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

1605

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

1606

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1607

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1608

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1609

# projects/[project_id]/global/images/[image-id]

1610

# image-idImage family examples. Dataproc will use the most recent image from the family:

1611

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1612

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

1613

"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.

1614

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

1615

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

1616

},

1617

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

1618

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

1619

"A String",

1620

],

1621

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1622

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1623

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1624

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

1625

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

1626

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1627

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

1628

},

1629

],

1630

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

1631

},

1632

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

1633

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1634

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

1635

"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.

1636

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

1637

"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).

1638

},

1639

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1640

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

1641

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

1642

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

1643

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

1644

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1645

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1646

# projects/[project_id]/global/images/[image-id]

1647

# image-idImage family examples. Dataproc will use the most recent image from the family:

1648

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1649

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

1650

"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.

1651

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

1652

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

1653

},

1654

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

1655

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

1656

"A String",

1657

],

1658

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1659

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1660

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1661

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

1662

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

1663

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1664

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

1665

},

1666

],

1667

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

1668

},

1669

},

1670

"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.

1671

},

1672

},

1673

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

1674

"name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

1675

# For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

1676

# For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

1677

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

1678

{ # 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)

1679

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

1680

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

1681

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

"A String",

],

},

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

1686

"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",

],

},

},

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

1692

# Values in maps can be referenced by key:

1693

# labels'key'

1694

# placement.clusterSelector.clusterLabels'key'

1695

# placement.managedCluster.labels'key'

1696

# placement.clusterSelector.clusterLabels'key'

1697

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

1698

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

1699

# jobs'step-id'.hadoopJob.mainJarFileUri

1700

# jobs'step-id'.hiveJob.queryFileUri

1701

# jobs'step-id'.pySparkJob.mainPythonFileUri

1702

# jobs'step-id'.hadoopJob.jarFileUris0

1703

# jobs'step-id'.hadoopJob.archiveUris0

1704

# jobs'step-id'.hadoopJob.fileUris0

1705

# jobs'step-id'.pySparkJob.pythonFileUris0

1706

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

1707

# jobs'step-id'.sparkJob.args0

1708

# Other examples:

1709

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

1710

# jobs'step-id'.hadoopJob.args0

1711

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

1712

# jobs'step-id'.hadoopJob.mainJarFileUri

1713

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

1714

# placement.clusterSelector.clusterLabels

1715

# jobs'step-id'.sparkJob.args

1716

"A String",

1717

],

1718

"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.

1719

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

1720

},

1721

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

1727

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

1728

1729

Args:

1730

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

1731

body: object, The request body.

1732

The object takes the form of:

1733

1734

{ # Request message for GetIamPolicy method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1735

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

1736

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1737

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1738

}

1739

1740

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1747

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1748

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1749

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1750

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1751

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1752

# "role": "roles/resourcemanager.organizationAdmin",

1753

# "members": [

1754

# "user:mike@example.com",

1755

# "group:admins@example.com",

1756

# "domain:google.com",

1757

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1758

# ]

1759

# },

1760

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1761

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1762

# "members": [

1763

# "user:eve@example.com"

1764

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1765

# "condition": {

1766

# "title": "expirable access",

1767

# "description": "Does not grant access after Sep 2020",

1768

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1769

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1770

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1771

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1772

# "etag": "BwWWja0YfJA=",

1773

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1774

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1775

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1776

# bindings:

1777

# - members:

1778

# - user:mike@example.com

1779

# - group:admins@example.com

1780

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1781

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1782

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1783

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1784

# - user:eve@example.com

1785

# role: roles/resourcemanager.organizationViewer

1786

# condition:

1787

# title: expirable access

1788

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1789

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1790

# - etag: BwWWja0YfJA=

1791

# - version: 3

1792

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1793

"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.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

1794

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

1795

# Getting a policy that includes a conditional role binding

1796

# Adding a conditional role binding to a policy

1797

# Changing a conditional role binding in a policy

1798

# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1799

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1800

{ # Associates members with a role.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1801

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1802

# title: "Summary size limit"

1803

# description: "Determines if a summary is less than 100 chars"

1804

# expression: "document.summary.size() < 100"

1805

# Example (Equality):

1806

# title: "Requestor is owner"

1807

# description: "Determines if requestor is the document owner"

1808

# expression: "document.owner == request.auth.claims.email"

1809

# Example (Logic):

1810

# title: "Public documents"

1811

# description: "Determine whether the document should be publicly visible"

1812

# expression: "document.type != 'private' && document.type != 'internal'"

1813

# Example (Data Manipulation):

1814

# title: "Notification string"

1815

# description: "Create a notification string with a timestamp."

1816

# expression: "'New message received at ' + string(document.create_time)"

1817

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

1818

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

1819

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1820

"title": "A String", # 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.

1821

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

1822

},

1823

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1824

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

1825

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1826

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1827

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

1828

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1829

# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.

1830

# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.

1831

# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1832

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1833

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1834

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1835

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1836

},

1837

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1842

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

1843

<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 (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1844

1845

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1846

name: string, Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

1847

For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

1848

For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)

1849

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1850

The object takes the form of:

1851

1852

{ # A request to instantiate a workflow template.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1853

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1854

"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.

1855

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

1856

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1867

1868

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1869

"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.

1870

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

1871

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1872

"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.

1873

"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.

1874

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1875

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1876

"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}.

1877

"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.

1878

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

1879

"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.

1880

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1881

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1882

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1890

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

1891

<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 (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1892

1893

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1894

parent: string, Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

1895

For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region}

1896

For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} (required)

1897

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1898

The object takes the form of:

1899

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1900

{ # A Dataproc workflow template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1901

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1902

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1903

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1904

{ # A job executed by the workflow.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1905

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

1906

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

1907

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1908

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1909

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

1910

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1917

# ]

1918

# }

1919

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1920

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1921

],

1922

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1923

"clientTags": [ # Optional. Presto client tags to attach to this query

1924

"A String",

1925

],

1926

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

1927

"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",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

1932

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1933

},

1934

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1935

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

1936

"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.

1937

},

1938

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1939

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

1940

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

1945

"a_key": "A String",

1946

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1947

"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.

1948

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

1949

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

1950

"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",

],

},

"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.

1964

"A String",

1965

],

1966

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

1967

"a_key": "A String",

1968

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1969

},

1970

"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.

1971

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

1972

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1973

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

1974

"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",

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1987

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1988

"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.

1989

"A String",

1990

],

1991

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

1992

"a_key": "A String",

1993

},

1994

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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",

},

},

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

1999

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2000

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2001

"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.

2002

"a_key": "A String",

2003

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2004

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2005

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

2006

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

2007

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2014

# ]

2015

# }

2016

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2017

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2018

],

2019

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2020

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

2021

"a_key": "A String",

2022

},

2023

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

2024

"A String",

2025

],

2026

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

2027

"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",

},

},

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

"a_key": "A String",

},

},

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

2036

"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.

2037

"A String",

2038

],

2039

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

2040

"A String",

2041

],

2042

"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.

2043

"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.

2044

"A String",

2045

],

2046

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

2047

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

2048

"A String",

2049

],

2050

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

2051

"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",

},

},

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

2056

"a_key": "A String",

2057

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2058

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2059

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

2060

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

2061

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2062

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2063

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

2064

"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'

2065

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2066

},

2067

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2068

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

2069

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2070

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2071

"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.

2072

"A String",

2073

],

2074

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

2075

"A String",

2076

],

2077

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

2078

"A String",

2079

],

2080

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

2081

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

2082

"A String",

2083

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2084

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2085

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

2086

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

2087

"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'

2088

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2089

},

2090

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2091

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

2092

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2093

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2094

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

2095

"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.

2096

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2097

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2098

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

2099

"A String",

2100

],

2101

"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.

"A String",

],

},

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

2106

"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.

2107

"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.

2108

"A String",

2109

],

2110

"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'

2111

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

2112

"A String",

2113

],

2114

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

2115

"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'

2116

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2117

},

2118

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2119

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

2120

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2121

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2122

"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.

2123

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2124

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2125

"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.

2126

"A String",

2127

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2128

},

2129

},

2130

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2131

"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.

2132

"a_key": "A String",

2133

},

2134

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2135

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

2136

"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.

2137

"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.

2138

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

"a_key": "A String",

},

},

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

2143

"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.

2144

"a_key": "A String",

2145

},

2146

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

2147

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

2148

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

2149

},

2150

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

2151

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

2152

"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.

2153

"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.

2154

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

2155

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

2156

"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.

2157

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

2158

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

2159

"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.

2160

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

2161

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

2162

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

2163

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

2164

"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.

2165

"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.

2166

"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.

2167

},

2168

},

2169

"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):

2170

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

2171

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

2172

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

2173

# ... master specific actions ...

2174

# else

2175

# ... worker specific actions ...

2176

# fi

2177

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

2178

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

2179

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

2180

},

2181

],

2182

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

2183

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

2184

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

2185

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

2186

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

2187

},

2188

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

2189

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

2190

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

2191

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

2192

"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.

2193

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

2194

"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).

2195

},

2196

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

2197

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

2198

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

2199

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

2200

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2201

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

2202

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

2203

# projects/[project_id]/global/images/[image-id]

2204

# image-idImage family examples. Dataproc will use the most recent image from the family:

2205

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

2206

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

2207

"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.

2208

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

2209

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

2210

},

2211

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

2212

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

2213

"A String",

2214

],

2215

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

2216

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

2217

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

2218

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

2219

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

2220

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2221

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

2222

},

2223

],

2224

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

2225

},

2226

"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.

2227

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

2228

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

2229

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

2230

# sub0

2231

"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 (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

2232

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

2233

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

2234

# default

2235

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

2236

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

2237

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

2238

# us-central1-f

2239

"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)).

2240

"a_key": "A String",

2241

},

2242

"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.

2243

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

2244

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

2245

"values": [ # Optional. Corresponds to the label values of reservation resource.

2246

"A String",

2247

],

2248

"consumeReservationType": "A String", # Optional. Type of reservation to consume

2249

},

2250

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

2251

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

2252

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

2253

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

2254

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

2255

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

2256

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

2257

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

2258

"A String",

2259

],

2260

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

2261

"A String",

2262

],

2263

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

2264

},

2265

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

2266

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

2267

"A String",

2268

],

2269

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

2270

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

2271

# capacity-scheduler: capacity-scheduler.xml

2272

# core: core-site.xml

2273

# distcp: distcp-default.xml

2274

# hdfs: hdfs-site.xml

2275

# hive: hive-site.xml

2276

# mapred: mapred-site.xml

2277

# pig: pig.properties

2278

# spark: spark-defaults.conf

2279

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

"a_key": "A String",

},

},

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

2284

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

2285

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

2286

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

2287

},

2288

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

2289

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

2290

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

2291

"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.

2292

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

2293

"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).

2294

},

2295

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

2296

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

2297

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

2298

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

2299

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2300

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

2301

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

2302

# projects/[project_id]/global/images/[image-id]

2303

# image-idImage family examples. Dataproc will use the most recent image from the family:

2304

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

2305

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

2306

"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.

2307

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

2308

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

2309

},

2310

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

2311

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

2312

"A String",

2313

],

2314

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

2315

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

2316

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

2317

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

2318

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

2319

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2320

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

2321

},

2322

],

2323

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

2324

},

2325

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

2326

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

2327

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

2328

"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.

2329

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

2330

"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).

2331

},

2332

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

2333

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

2334

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

2335

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

2336

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2337

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

2338

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

2339

# projects/[project_id]/global/images/[image-id]

2340

# image-idImage family examples. Dataproc will use the most recent image from the family:

2341

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

2342

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

2343

"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.

2344

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

2345

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

2346

},

2347

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

2348

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

2349

"A String",

2350

],

2351

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

2352

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

2353

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

2354

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

2355

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

2356

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2357

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

2358

},

2359

],

2360

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

2361

},

2362

},

2363

"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.

2364

},

2365

},

2366

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

2367

"name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

2368

# For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

2369

# For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

2370

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

2371

{ # 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)

2372

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

2373

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

2374

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

"A String",

],

},

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

2379

"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",

],

},

},

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

2385

# Values in maps can be referenced by key:

2386

# labels'key'

2387

# placement.clusterSelector.clusterLabels'key'

2388

# placement.managedCluster.labels'key'

2389

# placement.clusterSelector.clusterLabels'key'

2390

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

2391

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

2392

# jobs'step-id'.hadoopJob.mainJarFileUri

2393

# jobs'step-id'.hiveJob.queryFileUri

2394

# jobs'step-id'.pySparkJob.mainPythonFileUri

2395

# jobs'step-id'.hadoopJob.jarFileUris0

2396

# jobs'step-id'.hadoopJob.archiveUris0

2397

# jobs'step-id'.hadoopJob.fileUris0

2398

# jobs'step-id'.pySparkJob.pythonFileUris0

2399

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

2400

# jobs'step-id'.sparkJob.args0

2401

# Other examples:

2402

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

2403

# jobs'step-id'.hadoopJob.args0

2404

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

2405

# jobs'step-id'.hadoopJob.mainJarFileUri

2406

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

2407

# placement.clusterSelector.clusterLabels

2408

# jobs'step-id'.sparkJob.args

2409

"A String",

2410

],

2411

"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.

2412

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

2413

},

2414

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2415

}

2416

2417

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.

2418

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2425

2426

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2427

"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.

2428

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

2429

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2430

"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.

2431

"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.

2432

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2433

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2434

"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}.

2435

"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.

2436

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

2437

"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.

2438

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2439

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2440

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2448

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2449

<pre>Lists workflows that match the specified filter in the request.

2450

2451

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2452

parent: string, Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.

2453

For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region}

2454

For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2455

pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2456

pageSize: integer, Optional. The maximum number of results to return in each response.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2457

x__xgafv: string, V1 error format.

2458

Allowed values

2459

1 - v1 error format

2460

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2461

2462

Returns:

2463

An object of the form:

2464

2465

{ # A response to a request to list workflow templates in a project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2466

"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>.

2467

"templates": [ # Output only. WorkflowTemplates list.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2468

{ # A Dataproc workflow template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2469

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2470

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2471

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2472

{ # A job executed by the workflow.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2473

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

2474

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

2475

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2476

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2477

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

2478

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2485

# ]

2486

# }

2487

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2488

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2489

],

2490

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2491

"clientTags": [ # Optional. Presto client tags to attach to this query

2492

"A String",

2493

],

2494

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

2495

"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",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

2500

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2501

},

2502

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2503

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

2504

"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.

2505

},

2506

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2507

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

2508

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

2513

"a_key": "A String",

2514

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2515

"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.

2516

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

2517

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

2518

"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",

],

},

"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.

2532

"A String",

2533

],

2534

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

2535

"a_key": "A String",

2536

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2537

},

2538

"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.

2539

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

2540

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2541

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

2542

"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",

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2555

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2556

"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.

2557

"A String",

2558

],

2559

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

2560

"a_key": "A String",

2561

},

2562

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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",

},

},

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

2567

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2568

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2569

"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.

2570

"a_key": "A String",

2571

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2572

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2573

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

2574

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

2575

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2582

# ]

2583

# }

2584

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2585

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2586

],

2587

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2588

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

2589

"a_key": "A String",

2590

},

2591

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

2592

"A String",

2593

],

2594

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

2595

"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",

},

},

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

"a_key": "A String",

},

},

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

2604

"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.

2605

"A String",

2606

],

2607

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

2608

"A String",

2609

],

2610

"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.

2611

"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.

2612

"A String",

2613

],

2614

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

2615

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

2616

"A String",

2617

],

2618

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

2619

"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",

},

},

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

2624

"a_key": "A String",

2625

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2626

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2627

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

2628

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

2629

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2630

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2631

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

2632

"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'

2633

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2634

},

2635

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2636

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

2637

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2638

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2639

"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.

2640

"A String",

2641

],

2642

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

2643

"A String",

2644

],

2645

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

2646

"A String",

2647

],

2648

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

2649

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

2650

"A String",

2651

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2652

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2653

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

2654

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

2655

"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'

2656

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2657

},

2658

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2659

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

2660

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2661

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2662

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

2663

"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.

2664

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2665

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2666

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

2667

"A String",

2668

],

2669

"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.

"A String",

],

},

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

2674

"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.

2675

"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.

2676

"A String",

2677

],

2678

"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'

2679

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

2680

"A String",

2681

],

2682

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

2683

"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'

2684

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2685

},

2686

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2687

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

2688

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2689

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2690

"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.

2691

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2692

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2693

"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.

2694

"A String",

2695

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2696

},

2697

},

2698

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2699

"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.

2700

"a_key": "A String",

2701

},

2702

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2703

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

2704

"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.

2705

"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.

2706

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

"a_key": "A String",

},

},

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

2711

"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.

2712

"a_key": "A String",

2713

},

2714

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

2715

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

2716

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

2717

},

2718

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

2719

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

2720

"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.

2721

"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.

2722

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

2723

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

2724

"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.

2725

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

2726

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

2727

"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.

2728

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

2729

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

2730

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

2731

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

2732

"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.

2733

"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.

2734

"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.

2735

},

2736

},

2737

"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):

2738

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

2739

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

2740

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

2741

# ... master specific actions ...

2742

# else

2743

# ... worker specific actions ...

2744

# fi

2745

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

2746

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

2747

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

2748

},

2749

],

2750

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

2751

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

2752

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

2753

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

2754

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

2755

},

2756

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

2757

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

2758

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

2759

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

2760

"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.

2761

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

2762

"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).

2763

},

2764

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

2765

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

2766

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

2767

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

2768

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2769

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

2770

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

2771

# projects/[project_id]/global/images/[image-id]

2772

# image-idImage family examples. Dataproc will use the most recent image from the family:

2773

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

2774

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

2775

"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.

2776

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

2777

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

2778

},

2779

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

2780

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

2781

"A String",

2782

],

2783

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

2784

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

2785

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

2786

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

2787

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

2788

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2789

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

2790

},

2791

],

2792

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

2793

},

2794

"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.

2795

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

2796

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

2797

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

2798

# sub0

2799

"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 (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

2800

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

2801

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

2802

# default

2803

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

2804

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

2805

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

2806

# us-central1-f

2807

"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)).

2808

"a_key": "A String",

2809

},

2810

"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.

2811

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

2812

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

2813

"values": [ # Optional. Corresponds to the label values of reservation resource.

2814

"A String",

2815

],

2816

"consumeReservationType": "A String", # Optional. Type of reservation to consume

2817

},

2818

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

2819

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

2820

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

2821

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

2822

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

2823

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

2824

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

2825

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

2826

"A String",

2827

],

2828

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

2829

"A String",

2830

],

2831

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

2832

},

2833

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

2834

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

2835

"A String",

2836

],

2837

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

2838

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

2839

# capacity-scheduler: capacity-scheduler.xml

2840

# core: core-site.xml

2841

# distcp: distcp-default.xml

2842

# hdfs: hdfs-site.xml

2843

# hive: hive-site.xml

2844

# mapred: mapred-site.xml

2845

# pig: pig.properties

2846

# spark: spark-defaults.conf

2847

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

"a_key": "A String",

},

},

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

2852

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

2853

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

2854

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

2855

},

2856

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

2857

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

2858

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

2859

"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.

2860

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

2861

"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).

2862

},

2863

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

2864

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

2865

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

2866

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

2867

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2868

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

2869

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

2870

# projects/[project_id]/global/images/[image-id]

2871

# image-idImage family examples. Dataproc will use the most recent image from the family:

2872

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

2873

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

2874

"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.

2875

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

2876

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

2877

},

2878

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

2879

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

2880

"A String",

2881

],

2882

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

2883

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

2884

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

2885

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

2886

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

2887

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2888

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

2889

},

2890

],

2891

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

2892

},

2893

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

2894

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

2895

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

2896

"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.

2897

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

2898

"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).

2899

},

2900

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

2901

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

2902

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

2903

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

2904

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

2905

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

2906

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

2907

# projects/[project_id]/global/images/[image-id]

2908

# image-idImage family examples. Dataproc will use the most recent image from the family:

2909

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

2910

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

2911

"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.

2912

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

2913

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

2914

},

2915

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

2916

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

2917

"A String",

2918

],

2919

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

2920

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

2921

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

2922

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

2923

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

2924

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

2925

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

2926

},

2927

],

2928

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

2929

},

2930

},

2931

"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.

2932

},

2933

},

2934

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

2935

"name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

2936

# For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

2937

# For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

2938

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

2939

{ # 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)

2940

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

2941

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

2942

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

"A String",

],

},

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

2947

"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",

],

},

},

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

2953

# Values in maps can be referenced by key:

2954

# labels'key'

2955

# placement.clusterSelector.clusterLabels'key'

2956

# placement.managedCluster.labels'key'

2957

# placement.clusterSelector.clusterLabels'key'

2958

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

2959

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

2960

# jobs'step-id'.hadoopJob.mainJarFileUri

2961

# jobs'step-id'.hiveJob.queryFileUri

2962

# jobs'step-id'.pySparkJob.mainPythonFileUri

2963

# jobs'step-id'.hadoopJob.jarFileUris0

2964

# jobs'step-id'.hadoopJob.archiveUris0

2965

# jobs'step-id'.hadoopJob.fileUris0

2966

# jobs'step-id'.pySparkJob.pythonFileUris0

2967

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

2968

# jobs'step-id'.sparkJob.args0

2969

# Other examples:

2970

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

2971

# jobs'step-id'.hadoopJob.args0

2972

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

2973

# jobs'step-id'.hadoopJob.mainJarFileUri

2974

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

2975

# placement.clusterSelector.clusterLabels

2976

# jobs'step-id'.sparkJob.args

2977

"A String",

2978

],

2979

"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.

2980

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

2981

},

2982

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2990

<pre>Retrieves the next page of results.

2991

2992

Args:

2993

previous_request: The request for the previous page. (required)

2994

previous_response: The response from the request for the previous page. (required)

2995

2996

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2997

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2998

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3003

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3004

<pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3005

3006

Args:

3007

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3008

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3009

The object takes the form of:

3010

3011

{ # Request message for SetIamPolicy method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3012

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3013

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3014

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3015

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3016

# "role": "roles/resourcemanager.organizationAdmin",

3017

# "members": [

3018

# "user:mike@example.com",

3019

# "group:admins@example.com",

3020

# "domain:google.com",

3021

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3022

# ]

3023

# },

3024

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3025

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3026

# "members": [

3027

# "user:eve@example.com"

3028

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

# "condition": {

3030

# "title": "expirable access",

3031

# "description": "Does not grant access after Sep 2020",

3032

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3033

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3034

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3035

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3036

# "etag": "BwWWja0YfJA=",

3037

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3038

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3039

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3040

# bindings:

3041

# - members:

3042

# - user:mike@example.com

3043

# - group:admins@example.com

3044

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3045

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

3046

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3047

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3048

# - user:eve@example.com

3049

# role: roles/resourcemanager.organizationViewer

3050

# condition:

3051

# title: expirable access

3052

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3053

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3054

# - etag: BwWWja0YfJA=

3055

# - version: 3

3056

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3057

"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.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

3058

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

3059

# Getting a policy that includes a conditional role binding

3060

# Adding a conditional role binding to a policy

3061

# Changing a conditional role binding in a policy

3062

# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3063

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3064

{ # Associates members with a role.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3065

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3066

# title: "Summary size limit"

3067

# description: "Determines if a summary is less than 100 chars"

3068

# expression: "document.summary.size() < 100"

3069

# Example (Equality):

3070

# title: "Requestor is owner"

3071

# description: "Determines if requestor is the document owner"

3072

# expression: "document.owner == request.auth.claims.email"

3073

# Example (Logic):

3074

# title: "Public documents"

3075

# description: "Determine whether the document should be publicly visible"

3076

# expression: "document.type != 'private' && document.type != 'internal'"

3077

# Example (Data Manipulation):

3078

# title: "Notification string"

3079

# description: "Create a notification string with a timestamp."

3080

# expression: "'New message received at ' + string(document.create_time)"

3081

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

3082

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

3083

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3084

"title": "A String", # 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.

3085

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

3086

},

3087

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3088

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

3089

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3090

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3091

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

3092

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3093

# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.

3094

# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.

3095

# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3096

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3097

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3098

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3099

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3100

},

3101

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3112

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3113

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3114

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3115

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3116

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3117

# "role": "roles/resourcemanager.organizationAdmin",

3118

# "members": [

3119

# "user:mike@example.com",

3120

# "group:admins@example.com",

3121

# "domain:google.com",

3122

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3123

# ]

3124

# },

3125

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3126

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3127

# "members": [

3128

# "user:eve@example.com"

3129

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3130

# "condition": {

3131

# "title": "expirable access",

3132

# "description": "Does not grant access after Sep 2020",

3133

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3134

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3135

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3136

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3137

# "etag": "BwWWja0YfJA=",

3138

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3139

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3140

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3141

# bindings:

3142

# - members:

3143

# - user:mike@example.com

3144

# - group:admins@example.com

3145

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3146

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

3147

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3148

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3149

# - user:eve@example.com

3150

# role: roles/resourcemanager.organizationViewer

3151

# condition:

3152

# title: expirable access

3153

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3154

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3155

# - etag: BwWWja0YfJA=

3156

# - version: 3

3157

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3158

"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.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

3159

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

3160

# Getting a policy that includes a conditional role binding

3161

# Adding a conditional role binding to a policy

3162

# Changing a conditional role binding in a policy

3163

# Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3164

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3165

{ # Associates members with a role.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3166

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3167

# title: "Summary size limit"

3168

# description: "Determines if a summary is less than 100 chars"

3169

# expression: "document.summary.size() < 100"

3170

# Example (Equality):

3171

# title: "Requestor is owner"

3172

# description: "Determines if requestor is the document owner"

3173

# expression: "document.owner == request.auth.claims.email"

3174

# Example (Logic):

3175

# title: "Public documents"

3176

# description: "Determine whether the document should be publicly visible"

3177

# expression: "document.type != 'private' && document.type != 'internal'"

3178

# Example (Data Manipulation):

3179

# title: "Notification string"

3180

# description: "Create a notification string with a timestamp."

3181

# expression: "'New message received at ' + string(document.create_time)"

3182

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

3183

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

3184

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

3185

"title": "A String", # 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.

3186

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

3187

},

3188

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3189

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

3190

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3191

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3192

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

3193

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3194

# deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.

3195

# deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.

3196

# deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3197

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3198

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3199

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3200

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3201

},

3202

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3207

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3208

<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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3209

3210

Args:

3211

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)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3212

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3213

The object takes the form of:

3214

3215

{ # Request message for TestIamPermissions method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3216

"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).

3217

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3228

3229

{ # Response message for TestIamPermissions method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3230

"permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.

3231

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3237

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3238

<pre>Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

3239

3240

Args:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3241

name: string, Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

3242

For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

3243

For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)

3244

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3245

The object takes the form of:

3246

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3247

{ # A Dataproc workflow template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3248

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3249

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3250

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3251

{ # A job executed by the workflow.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3252

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

3253

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

3254

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3255

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3256

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

3257

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3264

# ]

3265

# }

3266

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3267

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3268

],

3269

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3270

"clientTags": [ # Optional. Presto client tags to attach to this query

3271

"A String",

3272

],

3273

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

3274

"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",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

3279

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3280

},

3281

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3282

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

3283

"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.

3284

},

3285

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3286

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

3287

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

3292

"a_key": "A String",

3293

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3294

"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.

3295

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

3296

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

3297

"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",

],

},

"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.

3311

"A String",

3312

],

3313

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

3314

"a_key": "A String",

3315

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3316

},

3317

"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.

3318

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

3319

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3320

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

3321

"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",

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3334

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3335

"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.

3336

"A String",

3337

],

3338

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

3339

"a_key": "A String",

3340

},

3341

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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",

},

},

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

3346

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3347

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3348

"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.

3349

"a_key": "A String",

3350

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3351

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3352

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

3353

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

3354

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3361

# ]

3362

# }

3363

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3364

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3365

],

3366

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3367

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

3368

"a_key": "A String",

3369

},

3370

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

3371

"A String",

3372

],

3373

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

3374

"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",

},

},

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

"a_key": "A String",

},

},

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

3383

"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.

3384

"A String",

3385

],

3386

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

3387

"A String",

3388

],

3389

"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.

3390

"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.

3391

"A String",

3392

],

3393

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

3394

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

3395

"A String",

3396

],

3397

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

3398

"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",

},

},

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

3403

"a_key": "A String",

3404

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3405

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3406

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

3407

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

3408

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3409

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3410

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

3411

"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'

3412

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3413

},

3414

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3415

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

3416

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3418

"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.

3419

"A String",

3420

],

3421

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

3422

"A String",

3423

],

3424

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

3425

"A String",

3426

],

3427

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

3428

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

3429

"A String",

3430

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3431

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3432

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

3433

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

3434

"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'

3435

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3436

},

3437

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3438

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

3439

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3440

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3441

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

3442

"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.

3443

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3444

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3445

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

3446

"A String",

3447

],

3448

"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.

"A String",

],

},

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

3453

"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.

3454

"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.

3455

"A String",

3456

],

3457

"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'

3458

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

3459

"A String",

3460

],

3461

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3462

"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'

3463

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3464

},

3465

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3466

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

3467

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3468

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3469

"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.

3470

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3471

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3472

"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.

3473

"A String",

3474

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3475

},

3476

},

3477

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3478

"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.

3479

"a_key": "A String",

3480

},

3481

"createTime": "A String", # Output only. The time template was created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3482

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

3483

"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.

3484

"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.

3485

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

"a_key": "A String",

},

},

"managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.

3490

"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.

3491

"a_key": "A String",

3492

},

3493

"config": { # The cluster config. # Required. The cluster configuration.

3494

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

3495

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

3496

},

3497

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

3498

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

3499

"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.

3500

"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.

3501

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

3502

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

3503

"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.

3504

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

3505

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

3506

"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.

3507

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

3508

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

3509

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

3510

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

3511

"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.

3512

"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.

3513

"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.

3514

},

3515

},

3516

"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):

3517

# ROLE=$(curl -H Metadata-Flavor:Google

3518

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

3519

# if [[ "${ROLE}" == 'Master' ]]; then

3520

# ... master specific actions ...

3521

# else

3522

# ... worker specific actions ...

3523

# fi

3524

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

3525

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

3526

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

3527

},

3528

],

3529

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

3530

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

3531

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

3532

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

3533

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

3534

},

3535

"configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).

3536

"workerConfig": { # 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.

3537

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

3538

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

3539

"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.

3540

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

3541

"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).

3542

},

3543

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

3544

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

3545

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3546

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3547

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

3548

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

3549

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

3550

# projects/[project_id]/global/images/[image-id]

3551

# image-idImage family examples. Dataproc will use the most recent image from the family:

3552

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

3553

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

3554

"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.

3555

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

3556

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

3557

},

3558

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

3559

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

3560

"A String",

3561

],

3562

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

3563

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

3564

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

3565

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3566

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3567

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

3568

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

3569

},

3570

],

3571

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

3572

},

3573

"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.

3574

"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:

3575

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

3576

# projects/[project_id]/regions/us-east1/subnetworks/sub0

3577

# sub0

3578

"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 (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

3579

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

3580

# projects/[project_id]/regions/global/default

3581

# default

3582

"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 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:

3583

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

3584

# projects/[project_id]/zones/[zone]

3585

# us-central1-f

3586

"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)).

3587

"a_key": "A String",

3588

},

3589

"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.

3590

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

3591

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

3592

"values": [ # Optional. Corresponds to the label values of reservation resource.

3593

"A String",

3594

],

3595

"consumeReservationType": "A String", # Optional. Type of reservation to consume

3596

},

3597

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

3598

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

3599

# https://www.googleapis.com/auth/devstorage.read_write

3600

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

3601

# https://www.googleapis.com/auth/bigquery

3602

# https://www.googleapis.com/auth/bigtable.admin.table

3603

# https://www.googleapis.com/auth/bigtable.data

3604

# https://www.googleapis.com/auth/devstorage.full_control

3605

"A String",

3606

],

3607

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

3608

"A String",

3609

],

3610

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

3611

},

3612

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

3613

"optionalComponents": [ # Optional. The set of components to activate on the cluster.

3614

"A String",

3615

],

3616

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

3617

"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:

3618

# capacity-scheduler: capacity-scheduler.xml

3619

# core: core-site.xml

3620

# distcp: distcp-default.xml

3621

# hdfs: hdfs-site.xml

3622

# hive: hive-site.xml

3623

# mapred: mapred-site.xml

3624

# pig: pig.properties

3625

# spark: spark-defaults.conf

3626

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

"a_key": "A String",

},

},

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

3631

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

3632

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

3633

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

3634

},

3635

"masterConfig": { # 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.

3636

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

3637

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

3638

"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.

3639

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

3640

"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).

3641

},

3642

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

3643

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

3644

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3645

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3646

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

3647

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

3648

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

3649

# projects/[project_id]/global/images/[image-id]

3650

# image-idImage family examples. Dataproc will use the most recent image from the family:

3651

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

3652

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

3653

"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.

3654

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

3655

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

3656

},

3657

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

3658

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

3659

"A String",

3660

],

3661

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

3662

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

3663

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

3664

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3665

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3666

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

3667

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

3668

},

3669

],

3670

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

3671

},

3672

"secondaryWorkerConfig": { # 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.

3673

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

3674

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

3675

"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.

3676

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

3677

"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).

3678

},

3679

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

3680

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

3681

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3682

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

3683

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

3684

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

3685

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

3686

# projects/[project_id]/global/images/[image-id]

3687

# image-idImage family examples. Dataproc will use the most recent image from the family:

3688

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

3689

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

3690

"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.

3691

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

3692

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

3693

},

3694

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

3695

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

3696

"A String",

3697

],

3698

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

3699

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

3700

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

3701

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3702

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

3703

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

3704

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

3705

},

3706

],

3707

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

3708

},

3709

},

3710

"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.

3711

},

3712

},

3713

"updateTime": "A String", # Output only. The time template was last updated.

3714

"name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

3715

# For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

3716

# For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

3717

"parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

3718

{ # 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)

3719

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

3720

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

3721

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

3726

"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",

],

},

},

"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:

3732

# Values in maps can be referenced by key:

3733

# labels'key'

3734

# placement.clusterSelector.clusterLabels'key'

3735

# placement.managedCluster.labels'key'

3736

# placement.clusterSelector.clusterLabels'key'

3737

# jobs'step-id'.labels'key'

3738

# Jobs in the jobs list can be referenced by step-id:

3739

# jobs'step-id'.hadoopJob.mainJarFileUri

3740

# jobs'step-id'.hiveJob.queryFileUri

3741

# jobs'step-id'.pySparkJob.mainPythonFileUri

3742

# jobs'step-id'.hadoopJob.jarFileUris0

3743

# jobs'step-id'.hadoopJob.archiveUris0

3744

# jobs'step-id'.hadoopJob.fileUris0

3745

# jobs'step-id'.pySparkJob.pythonFileUris0

3746

# Items in repeated fields can be referenced by a zero-based index:

3747

# jobs'step-id'.sparkJob.args0

3748

# Other examples:

3749

# jobs'step-id'.hadoopJob.properties'key'

3750

# jobs'step-id'.hadoopJob.args0

3751

# jobs'step-id'.hiveJob.scriptVariables'key'

3752

# jobs'step-id'.hadoopJob.mainJarFileUri

3753

# 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:

3754

# placement.clusterSelector.clusterLabels

3755

# jobs'step-id'.sparkJob.args

3756

"A String",

3757

],

3758

"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.

3759

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

3760

},

3761

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3762

}

3763

3764

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

3771

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3772

{ # A Dataproc workflow template resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3773

"id": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3774

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3775

"jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3776

{ # A job executed by the workflow.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3777

"prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.

3778

"outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats

3779

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3780

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3781

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3782

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3789

# ]

3790

# }

3791

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3792

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3793

],

3794

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3795

"clientTags": [ # Optional. Presto client tags to attach to this query

3796

"A String",

3797

],

3798

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3799

"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",

},

},

"properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI

3804

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3805

},

3806

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3807

"scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.

3808

"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.

3809

},

3810

"pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3811

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3812

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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.

3817

"a_key": "A String",

3818

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3819

"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.

3820

"queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.

3821

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3822

"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",

],

},

"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.

3836

"A String",

3837

],

3838

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).

3839

"a_key": "A String",

3840

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3841

},

3842

"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.

3843

"hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.

3844

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3845

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3846

"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",

],

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3859

"queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3860

"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.

3861

"A String",

3862

],

3863

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).

3864

"a_key": "A String",

3865

},

3866

"properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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",

},

},

"prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.

3871

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3872

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3873

"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.

3874

"a_key": "A String",

3875

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3876

"sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3877

"queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.

3878

"queryList": { # A list of queries to run on a cluster. # A list of queries.

3879

"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",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3886

# ]

3887

# }

3888

# }

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3889

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3890

],

3891

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

3892

"scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).

3893

"a_key": "A String",

3894

},

3895

"jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.

3896

"A String",

3897

],

3898

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3899

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.

"a_key": "A String",

},

},

"sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.

3908

"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.

3909

"A String",

3910

],

3911

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.

3912

"A String",

3913

],

3914

"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.

3915

"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.

3916

"A String",

3917

],

3918

"mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.

3919

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.

3920

"A String",

3921

],

3922

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3923

"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",

},

},

"properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

3928

"a_key": "A String",

3929

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3930

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3931

"pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.

3932

"jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.

3933

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3934

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3935

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3936

"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'

3937

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3938

},

3939

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3940

"properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

3941

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3942

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3943

"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.

3944

"A String",

3945

],

3946

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.

3947

"A String",

3948

],

3949

"pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.

3950

"A String",

3951

],

3952

"mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.

3953

"archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.

3954

"A String",

3955

],

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3956

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3957

"sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.

3958

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3959

"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'

3960

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3961

},

3962

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3963

"properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.

3964

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3965

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3966

"mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.

3967

"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.

3968

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3969

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3970

"fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.

3971

"A String",

3972

],

3973

"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.

"A String",

],

},

"hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.

3978

"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.

3979

"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.

3980

"A String",

3981

],

3982

"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'

3983

"jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.

3984

"A String",

3985

],

3986

"loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.

3987

"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'

3988

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3989

},

3990

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3991

"properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.

3992

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3993

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3994

"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.

3995

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3996

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3997

"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.

3998

"A String",

3999

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4000

},

4001

},

4002

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4003

"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.

4004

"a_key": "A String",

4005

},

4006

"createTime": "A String", # Output only. The time template was created.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

4007

"placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.

4008

"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.

4009

"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.

4010

"clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.

"a_key": "A String",

},

},

"managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.

4015

"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.

4016

"a_key": "A String",

4017

},

4018

"config": { # The cluster config. # Required. The cluster configuration.

4019

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

4020

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

4021

},

4022

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

4023

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

4024

"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.

4025

"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.

4026

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

4027

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

4028

"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.

4029

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

4030

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

4031

"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.

4032

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

4033

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

4034

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

4035

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

4036

"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.

4037

"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.

4038

"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.

4039

},

4040

},

4041

"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):

4042

# ROLE=$(curl -H Metadata-Flavor:Google

4043

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

4044

# if [[ "${ROLE}" == 'Master' ]]; then

4045

# ... master specific actions ...

4046

# else

4047

# ... worker specific actions ...

4048

# fi

4049

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

4050

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

4051

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

4052

},

4053

],

4054

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

4055

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

4056

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

4057

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

4058

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

4059

},

4060

"configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).

4061

"workerConfig": { # 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.

4062

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

4063

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

4064

"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.

4065

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

4066

"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).

4067

},

4068

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

4069

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

4070

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

4071

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

4072

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

4073

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

4074

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

4075

# projects/[project_id]/global/images/[image-id]

4076

# image-idImage family examples. Dataproc will use the most recent image from the family:

4077

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

4078

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

4079

"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.

4080

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

4081

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

4082

},

4083

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

4084

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

4085

"A String",

4086

],

4087

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

4088

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

4089

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

4090

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

4091

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

4092

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

4093

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

4094

},

4095

],

4096

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

4097

},

4098

"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.

4099

"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:

4100

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

4101

# projects/[project_id]/regions/us-east1/subnetworks/sub0

4102

# sub0

4103

"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 (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

4104

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

4105

# projects/[project_id]/regions/global/default

4106

# default

4107

"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 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:

4108

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

4109

# projects/[project_id]/zones/[zone]

4110

# us-central1-f

4111

"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)).

4112

"a_key": "A String",

4113

},

4114

"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.

4115

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

4116

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

4117

"values": [ # Optional. Corresponds to the label values of reservation resource.

4118

"A String",

4119

],

4120

"consumeReservationType": "A String", # Optional. Type of reservation to consume

4121

},

4122

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

4123

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

4124

# https://www.googleapis.com/auth/devstorage.read_write

4125

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

4126

# https://www.googleapis.com/auth/bigquery

4127

# https://www.googleapis.com/auth/bigtable.admin.table

4128

# https://www.googleapis.com/auth/bigtable.data

4129

# https://www.googleapis.com/auth/devstorage.full_control

4130

"A String",

4131

],

4132

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

4133

"A String",

4134

],

4135

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

4136

},

4137

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

4138

"optionalComponents": [ # Optional. The set of components to activate on the cluster.

4139

"A String",

4140

],

4141

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

4142

"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:

4143

# capacity-scheduler: capacity-scheduler.xml

4144

# core: core-site.xml

4145

# distcp: distcp-default.xml

4146

# hdfs: hdfs-site.xml

4147

# hive: hive-site.xml

4148

# mapred: mapred-site.xml

4149

# pig: pig.properties

4150

# spark: spark-defaults.conf

4151

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

"a_key": "A String",

},

},

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

4156

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

4157

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

4158

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

4159

},

4160

"masterConfig": { # 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.

4161

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

4162

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

4163

"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.

4164

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

4165

"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).

4166

},

4167

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

4168

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

4169

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

4170

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

4171

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

4172

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

4173

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

4174

# projects/[project_id]/global/images/[image-id]

4175

# image-idImage family examples. Dataproc will use the most recent image from the family:

4176

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

4177

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

4178

"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.

4179

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

4180

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

4181

},

4182

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

4183

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

4184

"A String",

4185

],

4186

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

4187

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

4188

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

4189

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

4190

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

4191

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

4192

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

4193

},

4194

],

4195

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

4196

},

4197

"secondaryWorkerConfig": { # 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.

4198

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

4199

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

4200

"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.

4201

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

4202

"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).

4203

},

4204

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

4205

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

4206

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

4207

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

4208

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

4209

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

4210

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

4211

# projects/[project_id]/global/images/[image-id]

4212

# image-idImage family examples. Dataproc will use the most recent image from the family:

4213

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

4214

# projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.

4215

"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.

4216

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

4217

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

4218

},

4219

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

4220

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

4221

"A String",

4222

],

4223

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

4224

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

4225

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

4226

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

4227

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

4228

# nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

4229

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

4230

},

4231

],

4232

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

4233

},

4234

},

4235

"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.

4236

},

4237

},

4238

"updateTime": "A String", # Output only. The time template was last updated.

4239

"name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.

4240

# For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}

4241

# For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}

4242

"parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.

4243

{ # 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)

4244

"validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.

4245

"values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.

4246

"values": [ # Required. List of allowed values for the parameter.

"A String",

],

},

"regex": { # Validation based on regular expressions. # Validation based on regular expressions.

4251

"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",

],

},

},

"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:

4257

# Values in maps can be referenced by key:

4258

# labels'key'

4259

# placement.clusterSelector.clusterLabels'key'

4260

# placement.managedCluster.labels'key'

4261

# placement.clusterSelector.clusterLabels'key'

4262

# jobs'step-id'.labels'key'

4263

# Jobs in the jobs list can be referenced by step-id:

4264

# jobs'step-id'.hadoopJob.mainJarFileUri

4265

# jobs'step-id'.hiveJob.queryFileUri

4266

# jobs'step-id'.pySparkJob.mainPythonFileUri

4267

# jobs'step-id'.hadoopJob.jarFileUris0

4268

# jobs'step-id'.hadoopJob.archiveUris0

4269

# jobs'step-id'.hadoopJob.fileUris0

4270

# jobs'step-id'.pySparkJob.pythonFileUris0

4271

# Items in repeated fields can be referenced by a zero-based index:

4272

# jobs'step-id'.sparkJob.args0

4273

# Other examples:

4274

# jobs'step-id'.hadoopJob.properties'key'

4275

# jobs'step-id'.hadoopJob.args0

4276

# jobs'step-id'.hiveJob.scriptVariables'key'

4277

# jobs'step-id'.hadoopJob.mainJarFileUri

4278

# 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:

4279

# placement.clusterSelector.clusterLabels

4280

# jobs'step-id'.sparkJob.args

4281

"A String",

4282

],

4283

"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.

4284

"description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.

4285

},

4286

],

Bu Sun Kim