/
run_v2.projects.locations.jobs.executions.tasks.html
503 lines (476 loc) 路 54.8 KB
/
run_v2.projects.locations.jobs.executions.tasks.html
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
<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="run_v2.html">Cloud Run Admin API</a> . <a href="run_v2.projects.html">projects</a> . <a href="run_v2.projects.locations.html">locations</a> . <a href="run_v2.projects.locations.jobs.html">jobs</a> . <a href="run_v2.projects.locations.jobs.executions.html">executions</a> . <a href="run_v2.projects.locations.jobs.executions.tasks.html">tasks</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a Task.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Tasks from an Execution of a Job.</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>
<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="get">get(name, x__xgafv=None)</code>
<pre>Gets information about a Task.
Args:
name: string, Required. The full name of the Task. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution}/tasks/{task} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Task represents a single run of a container to completion.
"annotations": { # Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
"a_key": "A String",
},
"completionTime": "A String", # Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.
"conditions": [ # Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.
{ # Defines a status condition for a resource.
"executionReason": "A String", # A reason for the execution condition.
"lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
"message": "A String", # Human readable message indicating details about the current status.
"reason": "A String", # A common (service-level) reason for this condition.
"revisionReason": "A String", # A reason for the revision condition.
"severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
"state": "A String", # State of the condition.
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
"containers": [ # Holds the single container that defines the unit of execution for this task.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
],
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
"A String",
],
"dependsOn": [ # Container names which must start before this container.
"A String",
],
"env": [ # List of environment variables to set in the container.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER, and mnay not exceed 32768 characters.
"value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "", and the maximum length is 32768 bytes.
"valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
"secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
},
},
},
],
"image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
"livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
"failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # The header field value
},
],
"path": "A String", # Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
"name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
},
],
"resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
"cpuIdle": True or False, # Determines whether CPU should be throttled or not outside of requests.
"limits": { # Only 麓memory麓 and 'cpu' are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
"a_key": "A String",
},
"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
},
"startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
"failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # The header field value
},
],
"path": "A String", # Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"volumeMounts": [ # Volume to mount into the container's filesystem.
{ # VolumeMount describes a mounting of a Volume within a container.
"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
"name": "A String", # Required. This must match the Name of a Volume.
},
],
"workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
},
],
"createTime": "A String", # Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations.
"deleteTime": "A String", # Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
"encryptionKey": "A String", # Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
"etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
"execution": "A String", # Output only. The name of the parent Execution.
"executionEnvironment": "A String", # The execution environment being used to host this Task.
"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
"generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state.
"index": 42, # Output only. Index of the Task, unique per execution, and beginning at 0.
"job": "A String", # Output only. The name of the parent Job.
"labels": { # Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels
"a_key": "A String",
},
"lastAttemptResult": { # Result of a task attempt. # Output only. Result of the last attempt of this Task.
"exitCode": 42, # Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details.
"status": { # 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). # Output only. The status of this attempt. If the status code is OK, then the attempt succeeded.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
},
"logUri": "A String", # Output only. URI where logs for this execution can be found in Cloud Console.
"maxRetries": 42, # Number of retries allowed per Task, before marking this Task failed.
"name": "A String", # Output only. The unique name of this Task.
"observedGeneration": "A String", # Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
"retried": 42, # Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"serviceAccount": "A String", # Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
"startTime": "A String", # Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations.
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"uid": "A String", # Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
"updateTime": "A String", # Output only. The last-modified time.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
"cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
},
"emptyDir": { # Ephemeral storage which can be backed by real disks (HD, SSD), network storage or memory (i.e. tmpfs). For now only in memory (tmpfs) is supported. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
"medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
"sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. This field's values are of the 'Quantity' k8s type: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir +optional
},
"name": "A String", # Required. Volume's name.
"secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume.
"defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
"items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
{ # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
"mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
"path": "A String", # Required. The relative path of the secret in the container.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
},
],
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
},
},
],
"vpcAccess": { # VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc # Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
"connector": "A String", # VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number.
"egress": "A String", # Traffic VPC egress settings.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None)</code>
<pre>Lists Tasks from an Execution of a Job.
Args:
parent: string, Required. The Execution from which the Tasks should be listed. To list all Tasks across Executions of a Job, use "-" instead of Execution name. To list all Tasks across Jobs, use "-" instead of Job name. Format: projects/{project}/locations/{location}/jobs/{job}/executions/{execution} (required)
pageSize: integer, Maximum number of Tasks to return in this call.
pageToken: string, A page token received from a previous call to ListTasks. All other parameters must match.
showDeleted: boolean, If true, returns deleted (but unexpired) resources along with active ones.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message containing a list of Tasks.
"nextPageToken": "A String", # A token indicating there are more items than page_size. Use it in the next ListTasks request to continue.
"tasks": [ # The resulting list of Tasks.
{ # Task represents a single run of a container to completion.
"annotations": { # Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects.
"a_key": "A String",
},
"completionTime": "A String", # Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations.
"conditions": [ # Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state.
{ # Defines a status condition for a resource.
"executionReason": "A String", # A reason for the execution condition.
"lastTransitionTime": "A String", # Last time the condition transitioned from one status to another.
"message": "A String", # Human readable message indicating details about the current status.
"reason": "A String", # A common (service-level) reason for this condition.
"revisionReason": "A String", # A reason for the revision condition.
"severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info
"state": "A String", # State of the condition.
"type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready.
},
],
"containers": [ # Holds the single container that defines the unit of execution for this task.
{ # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime.
"args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided.
"A String",
],
"command": [ # Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided.
"A String",
],
"dependsOn": [ # Container names which must start before this container.
"A String",
],
"env": [ # List of environment variables to set in the container.
{ # EnvVar represents an environment variable present in a Container.
"name": "A String", # Required. Name of the environment variable. Must be a C_IDENTIFIER, and mnay not exceed 32768 characters.
"value": "A String", # Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to "", and the maximum length is 32768 bytes.
"valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value.
"secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager.
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias.
},
},
},
],
"image": "A String", # Required. Name of the container image in Dockerhub, Google Artifact Registry, or Google Container Registry. If the host is not provided, Dockerhub is assumed.
"livenessProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Periodic probe of container liveness. Container will be restarted if the probe fails.
"failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # The header field value
},
],
"path": "A String", # Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"name": "A String", # Name of the container specified as a DNS_LABEL (RFC 1123).
"ports": [ # List of ports to expose from the container. Only a single port can be specified. The specified ports must be listening on all interfaces (0.0.0.0) within the container to be accessible. If omitted, a port number will be chosen and passed to the container through the PORT environment variable for the container to listen on.
{ # ContainerPort represents a network port in a single container.
"containerPort": 42, # Port number the container listens on. This must be a valid TCP port number, 0 < container_port < 65536.
"name": "A String", # If specified, used to specify which protocol to use. Allowed values are "http1" and "h2c".
},
],
"resources": { # ResourceRequirements describes the compute resource requirements. # Compute Resource requirements by this container.
"cpuIdle": True or False, # Determines whether CPU should be throttled or not outside of requests.
"limits": { # Only 麓memory麓 and 'cpu' are supported. Notes: * The only supported values for CPU are '1', '2', '4', and '8'. Setting 4 CPU requires at least 2Gi of memory. For more information, go to https://cloud.google.com/run/docs/configuring/cpu. * For supported 'memory' values and syntax, go to https://cloud.google.com/run/docs/configuring/memory-limits
"a_key": "A String",
},
"startupCpuBoost": True or False, # Determines whether CPU should be boosted on startup of a new container instance above the requested CPU threshold, this can help reduce cold-start latency.
},
"startupProbe": { # Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. # Startup probe of application within the container. All other probes are disabled if a startup probe is provided, until it succeeds. Container will not be added to service endpoints if the probe fails.
"failureThreshold": 42, # Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.
"grpc": { # GRPCAction describes an action involving a GRPC port. # GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number of the gRPC service. Number must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
"service": "A String", # Service is the name of the service to place in the gRPC HealthCheckRequest (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md). If this is not specified, the default behavior is defined by gRPC.
},
"httpGet": { # HTTPGetAction describes an action based on HTTP Get requests. # HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"httpHeaders": [ # Custom headers to set in the request. HTTP allows repeated headers.
{ # HTTPHeader describes a custom header to be used in HTTP probes
"name": "A String", # Required. The header field name
"value": "A String", # The header field value
},
],
"path": "A String", # Path to access on the HTTP server. Defaults to '/'.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"initialDelaySeconds": 42, # Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.
"periodSeconds": 42, # How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.
"tcpSocket": { # TCPSocketAction describes an action based on opening a socket # TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.
"port": 42, # Port number to access on the container. Must be in the range 1 to 65535. If not specified, defaults to the exposed port of the container, which is the value of container.ports[0].containerPort.
},
"timeoutSeconds": 42, # Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.
},
"volumeMounts": [ # Volume to mount into the container's filesystem.
{ # VolumeMount describes a mounting of a Volume within a container.
"mountPath": "A String", # Required. Path within the container at which the volume should be mounted. Must not contain ':'. For Cloud SQL volumes, it can be left empty, or must otherwise be `/cloudsql`. All instances defined in the Volume will be available as `/cloudsql/[instance]`. For more information on Cloud SQL volumes, visit https://cloud.google.com/sql/docs/mysql/connect-run
"name": "A String", # Required. This must match the Name of a Volume.
},
],
"workingDir": "A String", # Container's working directory. If not specified, the container runtime's default will be used, which might be configured in the container image.
},
],
"createTime": "A String", # Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations.
"deleteTime": "A String", # Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request.
"encryptionKey": "A String", # Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek
"etag": "A String", # Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates.
"execution": "A String", # Output only. The name of the parent Execution.
"executionEnvironment": "A String", # The execution environment being used to host this Task.
"expireTime": "A String", # Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request.
"generation": "A String", # Output only. A number that monotonically increases every time the user modifies the desired state.
"index": 42, # Output only. Index of the Task, unique per execution, and beginning at 0.
"job": "A String", # Output only. The name of the parent Job.
"labels": { # Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels
"a_key": "A String",
},
"lastAttemptResult": { # Result of a task attempt. # Output only. Result of the last attempt of this Task.
"exitCode": 42, # Output only. The exit code of this attempt. This may be unset if the container was unable to exit cleanly with a code due to some other failure. See status field for possible failure details.
"status": { # 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). # Output only. The status of this attempt. If the status code is OK, then the attempt succeeded.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
},
"logUri": "A String", # Output only. URI where logs for this execution can be found in Cloud Console.
"maxRetries": 42, # Number of retries allowed per Task, before marking this Task failed.
"name": "A String", # Output only. The unique name of this Task.
"observedGeneration": "A String", # Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
"reconciling": True or False, # Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run.
"retried": 42, # Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"serviceAccount": "A String", # Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account.
"startTime": "A String", # Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations.
"timeout": "A String", # Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout.
"uid": "A String", # Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.
"updateTime": "A String", # Output only. The last-modified time.
"volumes": [ # A list of Volumes to make available to containers.
{ # Volume represents a named volume in a container.
"cloudSqlInstance": { # Represents a set of Cloud SQL instances. Each one will be available under /cloudsql/[instance]. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. # For Cloud SQL volumes, contains the specific instances that should be mounted. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run.
"instances": [ # The Cloud SQL instance connection names, as can be found in https://console.cloud.google.com/sql/instances. Visit https://cloud.google.com/sql/docs/mysql/connect-run for more information on how to connect Cloud SQL and Cloud Run. Format: {project}:{location}:{instance}
"A String",
],
},
"emptyDir": { # Ephemeral storage which can be backed by real disks (HD, SSD), network storage or memory (i.e. tmpfs). For now only in memory (tmpfs) is supported. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume.
"medium": "A String", # The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional
"sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers in a pod. This field's values are of the 'Quantity' k8s type: https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/. The default is nil which means that the limit is undefined. More info: http://kubernetes.io/docs/user-guide/volumes#emptydir +optional
},
"name": "A String", # Required. Volume's name.
"secret": { # The secret's value will be presented as the content of a file whose name is defined in the item path. If no items are defined, the name of the file is the secret. # Secret represents a secret that should populate this volume.
"defaultMode": 42, # Integer representation of mode bits to use on created files by default. Must be a value between 0000 and 0777 (octal), defaulting to 0444. Directories within the path are not affected by this setting. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set. This might be in conflict with other options that affect the file mode, like fsGroup, and as a result, other mode bits could be set.
"items": [ # If unspecified, the volume will expose a file whose name is the secret, relative to VolumeMount.mount_path. If specified, the key will be used as the version to fetch from Cloud Secret Manager and the path will be the name of the file exposed in the volume. When items are defined, they must specify a path and a version.
{ # VersionToPath maps a specific version of a secret to a relative file to mount to, relative to VolumeMount's mount_path.
"mode": 42, # Integer octal mode bits to use on this file, must be a value between 01 and 0777 (octal). If 0 or not set, the Volume's default mode will be used. Notes * Internally, a umask of 0222 will be applied to any non-zero value. * This is an integer representation of the mode bits. So, the octal integer value should look exactly as the chmod numeric notation with a leading zero. Some examples: for chmod 777 (a=rwx), set to 0777 (octal) or 511 (base-10). For chmod 640 (u=rw,g=r), set to 0640 (octal) or 416 (base-10). For chmod 755 (u=rwx,g=rx,o=rx), set to 0755 (octal) or 493 (base-10). * This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.
"path": "A String", # Required. The relative path of the secret in the container.
"version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest value, or an integer or a secret alias for a specific version.
},
],
"secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret} if the secret is in the same project. projects/{project}/secrets/{secret} if the secret is in a different project.
},
},
],
"vpcAccess": { # VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc # Output only. VPC Access configuration to use for this Task. For more information, visit https://cloud.google.com/run/docs/configuring/connecting-vpc.
"connector": "A String", # VPC Access connector name. Format: projects/{project}/locations/{location}/connectors/{connector}, where {project} can be project id or number.
"egress": "A String", # Traffic VPC egress settings.
},
},
],
}</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>
</body></html>