1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dataproc_v1.html">Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.locations.html">locations</a> . <a href="dataproc_v1.projects.locations.sessionTemplates.html">sessionTemplates</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Create a session template synchronously.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a session template.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the resource representation for a session template.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists session templates.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the session template synchronously.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Create a session template synchronously.
Args:
parent: string, Required. The parent resource where this session template will be created. (required)
body: object, The request body.
The object takes the form of:
{ # A representation of a session template.
"createTime": "A String", # Output only. The time when the template was created.
"creator": "A String", # Output only. The email address of the user who created the template.
"description": "A String", # Optional. Brief description of the template.
"environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution.
"executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload.
"authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s).
"userWorkloadAuthenticationType": "A String", # Optional. Authentication type for the user workload running in containers.
},
"idleTtl": "A String", # Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption.
"networkTags": [ # Optional. Tags used for network traffic control.
"A String",
],
"networkUri": "A String", # Optional. Network URI to connect workload to.
"serviceAccount": "A String", # Optional. Service account that used to execute workload.
"stagingBucket": "A String", # Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.
"subnetworkUri": "A String", # Optional. Subnetwork URI to connect workload to.
"ttl": "A String", # Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
},
"peripheralsConfig": { # Auxiliary services configuration for a workload. # Optional. Peripherals configuration that workload has access to.
"metastoreService": "A String", # Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
"sparkHistoryServerConfig": { # Spark History Server configuration for the workload. # Optional. The Spark History Server configuration for the workload.
"dataprocCluster": "A String", # Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
},
},
},
"jupyterSession": { # Jupyter configuration for an interactive session. # Optional. Jupyter session config.
"displayName": "A String", # Optional. Display name, shown in the Jupyter kernelspec card.
"kernel": "A String", # Optional. Kernel
},
"labels": { # Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the session template.
"runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution.
"autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload.
"scenarios": [ # Optional. Scenarios for which tunings are applied.
"A String",
],
},
"cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.
"containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
"properties": { # Optional. A mapping of property names to values, which are used to configure workload execution.
"a_key": "A String",
},
"repositoryConfig": { # Configuration for dependency repositories # Optional. Dependency repository configuration.
"pypiRepositoryConfig": { # Configuration for PyPi repository # Optional. Configuration for PyPi repository.
"pypiRepository": "A String", # Optional. PyPi repository address
},
},
"version": "A String", # Optional. Version of the batch runtime.
},
"sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config.
},
"updateTime": "A String", # Output only. The time the template was last updated.
"uuid": "A String", # Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A representation of a session template.
"createTime": "A String", # Output only. The time when the template was created.
"creator": "A String", # Output only. The email address of the user who created the template.
"description": "A String", # Optional. Brief description of the template.
"environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution.
"executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload.
"authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s).
"userWorkloadAuthenticationType": "A String", # Optional. Authentication type for the user workload running in containers.
},
"idleTtl": "A String", # Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption.
"networkTags": [ # Optional. Tags used for network traffic control.
"A String",
],
"networkUri": "A String", # Optional. Network URI to connect workload to.
"serviceAccount": "A String", # Optional. Service account that used to execute workload.
"stagingBucket": "A String", # Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.
"subnetworkUri": "A String", # Optional. Subnetwork URI to connect workload to.
"ttl": "A String", # Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
},
"peripheralsConfig": { # Auxiliary services configuration for a workload. # Optional. Peripherals configuration that workload has access to.
"metastoreService": "A String", # Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
"sparkHistoryServerConfig": { # Spark History Server configuration for the workload. # Optional. The Spark History Server configuration for the workload.
"dataprocCluster": "A String", # Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
},
},
},
"jupyterSession": { # Jupyter configuration for an interactive session. # Optional. Jupyter session config.
"displayName": "A String", # Optional. Display name, shown in the Jupyter kernelspec card.
"kernel": "A String", # Optional. Kernel
},
"labels": { # Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the session template.
"runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution.
"autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload.
"scenarios": [ # Optional. Scenarios for which tunings are applied.
"A String",
],
},
"cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.
"containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
"properties": { # Optional. A mapping of property names to values, which are used to configure workload execution.
"a_key": "A String",
},
"repositoryConfig": { # Configuration for dependency repositories # Optional. Dependency repository configuration.
"pypiRepositoryConfig": { # Configuration for PyPi repository # Optional. Configuration for PyPi repository.
"pypiRepository": "A String", # Optional. PyPi repository address
},
},
"version": "A String", # Optional. Version of the batch runtime.
},
"sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config.
},
"updateTime": "A String", # Output only. The time the template was last updated.
"uuid": "A String", # Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a session template.
Args:
name: string, Required. The name of the session template resource to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the resource representation for a session template.
Args:
name: string, Required. The name of the session template to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A representation of a session template.
"createTime": "A String", # Output only. The time when the template was created.
"creator": "A String", # Output only. The email address of the user who created the template.
"description": "A String", # Optional. Brief description of the template.
"environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution.
"executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload.
"authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s).
"userWorkloadAuthenticationType": "A String", # Optional. Authentication type for the user workload running in containers.
},
"idleTtl": "A String", # Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption.
"networkTags": [ # Optional. Tags used for network traffic control.
"A String",
],
"networkUri": "A String", # Optional. Network URI to connect workload to.
"serviceAccount": "A String", # Optional. Service account that used to execute workload.
"stagingBucket": "A String", # Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.
"subnetworkUri": "A String", # Optional. Subnetwork URI to connect workload to.
"ttl": "A String", # Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
},
"peripheralsConfig": { # Auxiliary services configuration for a workload. # Optional. Peripherals configuration that workload has access to.
"metastoreService": "A String", # Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
"sparkHistoryServerConfig": { # Spark History Server configuration for the workload. # Optional. The Spark History Server configuration for the workload.
"dataprocCluster": "A String", # Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
},
},
},
"jupyterSession": { # Jupyter configuration for an interactive session. # Optional. Jupyter session config.
"displayName": "A String", # Optional. Display name, shown in the Jupyter kernelspec card.
"kernel": "A String", # Optional. Kernel
},
"labels": { # Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the session template.
"runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution.
"autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload.
"scenarios": [ # Optional. Scenarios for which tunings are applied.
"A String",
],
},
"cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.
"containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
"properties": { # Optional. A mapping of property names to values, which are used to configure workload execution.
"a_key": "A String",
},
"repositoryConfig": { # Configuration for dependency repositories # Optional. Dependency repository configuration.
"pypiRepositoryConfig": { # Configuration for PyPi repository # Optional. Configuration for PyPi repository.
"pypiRepository": "A String", # Optional. PyPi repository address
},
},
"version": "A String", # Optional. Version of the batch runtime.
},
"sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config.
},
"updateTime": "A String", # Output only. The time the template was last updated.
"uuid": "A String", # Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists session templates.
Args:
parent: string, Required. The parent that owns this collection of session templates. (required)
filter: string, Optional. A filter for the session templates to return in the response. Filters are case sensitive and have the following syntax:field = value AND field = value ...
pageSize: integer, Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.
pageToken: string, Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A list of session templates.
"nextPageToken": "A String", # A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
"sessionTemplates": [ # Output only. Session template list
{ # A representation of a session template.
"createTime": "A String", # Output only. The time when the template was created.
"creator": "A String", # Output only. The email address of the user who created the template.
"description": "A String", # Optional. Brief description of the template.
"environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution.
"executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload.
"authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s).
"userWorkloadAuthenticationType": "A String", # Optional. Authentication type for the user workload running in containers.
},
"idleTtl": "A String", # Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption.
"networkTags": [ # Optional. Tags used for network traffic control.
"A String",
],
"networkUri": "A String", # Optional. Network URI to connect workload to.
"serviceAccount": "A String", # Optional. Service account that used to execute workload.
"stagingBucket": "A String", # Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.
"subnetworkUri": "A String", # Optional. Subnetwork URI to connect workload to.
"ttl": "A String", # Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
},
"peripheralsConfig": { # Auxiliary services configuration for a workload. # Optional. Peripherals configuration that workload has access to.
"metastoreService": "A String", # Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
"sparkHistoryServerConfig": { # Spark History Server configuration for the workload. # Optional. The Spark History Server configuration for the workload.
"dataprocCluster": "A String", # Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
},
},
},
"jupyterSession": { # Jupyter configuration for an interactive session. # Optional. Jupyter session config.
"displayName": "A String", # Optional. Display name, shown in the Jupyter kernelspec card.
"kernel": "A String", # Optional. Kernel
},
"labels": { # Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the session template.
"runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution.
"autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload.
"scenarios": [ # Optional. Scenarios for which tunings are applied.
"A String",
],
},
"cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.
"containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
"properties": { # Optional. A mapping of property names to values, which are used to configure workload execution.
"a_key": "A String",
},
"repositoryConfig": { # Configuration for dependency repositories # Optional. Dependency repository configuration.
"pypiRepositoryConfig": { # Configuration for PyPi repository # Optional. Configuration for PyPi repository.
"pypiRepository": "A String", # Optional. PyPi repository address
},
},
"version": "A String", # Optional. Version of the batch runtime.
},
"sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config.
},
"updateTime": "A String", # Output only. The time the template was last updated.
"uuid": "A String", # Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, x__xgafv=None)</code>
<pre>Updates the session template synchronously.
Args:
name: string, Required. Identifier. The resource name of the session template. (required)
body: object, The request body.
The object takes the form of:
{ # A representation of a session template.
"createTime": "A String", # Output only. The time when the template was created.
"creator": "A String", # Output only. The email address of the user who created the template.
"description": "A String", # Optional. Brief description of the template.
"environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution.
"executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload.
"authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s).
"userWorkloadAuthenticationType": "A String", # Optional. Authentication type for the user workload running in containers.
},
"idleTtl": "A String", # Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption.
"networkTags": [ # Optional. Tags used for network traffic control.
"A String",
],
"networkUri": "A String", # Optional. Network URI to connect workload to.
"serviceAccount": "A String", # Optional. Service account that used to execute workload.
"stagingBucket": "A String", # Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.
"subnetworkUri": "A String", # Optional. Subnetwork URI to connect workload to.
"ttl": "A String", # Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
},
"peripheralsConfig": { # Auxiliary services configuration for a workload. # Optional. Peripherals configuration that workload has access to.
"metastoreService": "A String", # Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
"sparkHistoryServerConfig": { # Spark History Server configuration for the workload. # Optional. The Spark History Server configuration for the workload.
"dataprocCluster": "A String", # Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
},
},
},
"jupyterSession": { # Jupyter configuration for an interactive session. # Optional. Jupyter session config.
"displayName": "A String", # Optional. Display name, shown in the Jupyter kernelspec card.
"kernel": "A String", # Optional. Kernel
},
"labels": { # Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the session template.
"runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution.
"autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload.
"scenarios": [ # Optional. Scenarios for which tunings are applied.
"A String",
],
},
"cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.
"containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
"properties": { # Optional. A mapping of property names to values, which are used to configure workload execution.
"a_key": "A String",
},
"repositoryConfig": { # Configuration for dependency repositories # Optional. Dependency repository configuration.
"pypiRepositoryConfig": { # Configuration for PyPi repository # Optional. Configuration for PyPi repository.
"pypiRepository": "A String", # Optional. PyPi repository address
},
},
"version": "A String", # Optional. Version of the batch runtime.
},
"sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config.
},
"updateTime": "A String", # Output only. The time the template was last updated.
"uuid": "A String", # Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A representation of a session template.
"createTime": "A String", # Output only. The time when the template was created.
"creator": "A String", # Output only. The email address of the user who created the template.
"description": "A String", # Optional. Brief description of the template.
"environmentConfig": { # Environment configuration for a workload. # Optional. Environment configuration for session execution.
"executionConfig": { # Execution configuration for a workload. # Optional. Execution configuration for a workload.
"authenticationConfig": { # Authentication configuration for a workload is used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s). # Optional. Authentication configuration used to set the default identity for the workload execution. The config specifies the type of identity (service account or user) that will be used by workloads to access resources on the project(s).
"userWorkloadAuthenticationType": "A String", # Optional. Authentication type for the user workload running in containers.
},
"idleTtl": "A String", # Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
"kmsKey": "A String", # Optional. The Cloud KMS key to use for encryption.
"networkTags": [ # Optional. Tags used for network traffic control.
"A String",
],
"networkUri": "A String", # Optional. Network URI to connect workload to.
"serviceAccount": "A String", # Optional. Service account that used to execute workload.
"stagingBucket": "A String", # Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.
"subnetworkUri": "A String", # Optional. Subnetwork URI to connect workload to.
"ttl": "A String", # Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.
},
"peripheralsConfig": { # Auxiliary services configuration for a workload. # Optional. Peripherals configuration that workload has access to.
"metastoreService": "A String", # Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]
"sparkHistoryServerConfig": { # Spark History Server configuration for the workload. # Optional. The Spark History Server configuration for the workload.
"dataprocCluster": "A String", # Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]
},
},
},
"jupyterSession": { # Jupyter configuration for an interactive session. # Optional. Jupyter session config.
"displayName": "A String", # Optional. Display name, shown in the Jupyter kernelspec card.
"kernel": "A String", # Optional. Kernel
},
"labels": { # Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.
"a_key": "A String",
},
"name": "A String", # Required. Identifier. The resource name of the session template.
"runtimeConfig": { # Runtime configuration for a workload. # Optional. Runtime configuration for session execution.
"autotuningConfig": { # Autotuning configuration of the workload. # Optional. Autotuning configuration of the workload.
"scenarios": [ # Optional. Scenarios for which tunings are applied.
"A String",
],
},
"cohort": "A String", # Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.
"containerImage": "A String", # Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.
"properties": { # Optional. A mapping of property names to values, which are used to configure workload execution.
"a_key": "A String",
},
"repositoryConfig": { # Configuration for dependency repositories # Optional. Dependency repository configuration.
"pypiRepositoryConfig": { # Configuration for PyPi repository # Optional. Configuration for PyPi repository.
"pypiRepository": "A String", # Optional. PyPi repository address
},
},
"version": "A String", # Optional. Version of the batch runtime.
},
"sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config.
},
"updateTime": "A String", # Output only. The time the template was last updated.
"uuid": "A String", # Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.
}</pre>
</div>
</body></html>
|
