Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / container_v1beta1.projects.zones.clusters.nodePools.html
blob: b7e50b5f9c3675419e1b10173f7fdd9ad615ba84 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="container_v1beta1.html">Kubernetes Engine API</a> . <a href="container_v1beta1.projects.html">projects</a> . <a href="container_v1beta1.projects.zones.html">zones</a> . <a href="container_v1beta1.projects.zones.clusters.html">clusters</a> . <a href="container_v1beta1.projects.zones.clusters.nodePools.html">nodePools</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Sets the autoscaling settings of a specific node pool.</p>
80<p class="toc_element">
81 <code><a href="#create">create(projectId, zone, clusterId, body, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a node pool for a cluster.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a node pool from a cluster.</p>
86<p class="toc_element">
87 <code><a href="#get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Retrieves the requested node pool.</p>
89<p class="toc_element">
90 <code><a href="#list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Lists the node pools for a cluster.</p>
92<p class="toc_element">
93 <code><a href="#rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p>
94<p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade.</p>
95<p class="toc_element">
96 <code><a href="#setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p>
97<p class="firstline">Sets the NodeManagement options for a node pool.</p>
98<p class="toc_element">
99 <code><a href="#setSize">setSize(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p>
100<p class="firstline">Sets the size for a specific node pool.</p>
101<p class="toc_element">
102 <code><a href="#update">update(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</a></code></p>
103<p class="firstline">Updates the version and/or image type of a specific node pool.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="autoscaling">autoscaling(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code>
107 <pre>Sets the autoscaling settings of a specific node pool.
108
109Args:
110 projectId: string, Deprecated. The Google Developers Console [project ID or project
111number](https://support.google.com/cloud/answer/6158840).
112This field has been deprecated and replaced by the name field. (required)
113 zone: string, Deprecated. The name of the Google Compute Engine
114[zone](/compute/docs/zones#available) in which the cluster
115resides.
116This field has been deprecated and replaced by the name field. (required)
117 clusterId: string, Deprecated. The name of the cluster to upgrade.
118This field has been deprecated and replaced by the name field. (required)
119 nodePoolId: string, Deprecated. The name of the node pool to upgrade.
120This field has been deprecated and replaced by the name field. (required)
121 body: object, The request body. (required)
122 The object takes the form of:
123
124{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
125 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set
126 # autoscaler settings. Specified in the format
127 # 'projects/*/locations/*/clusters/*/nodePools/*'.
128 "zone": "A String", # Deprecated. The name of the Google Compute Engine
129 # [zone](/compute/docs/zones#available) in which the cluster
130 # resides.
131 # This field has been deprecated and replaced by the name field.
132 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
133 # number](https://support.google.com/cloud/answer/6158840).
134 # This field has been deprecated and replaced by the name field.
135 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaling configuration for the node pool.
136 # adjust the size of the node pool to the current cluster usage.
137 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=
138 # max_node_count.
139 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
140 "enabled": True or False, # Is autoscaling enabled for this node pool.
141 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There
142 # has to enough quota to scale up the cluster.
143 },
144 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
145 # This field has been deprecated and replaced by the name field.
146 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.
147 # This field has been deprecated and replaced by the name field.
148 }
149
150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
154
155Returns:
156 An object of the form:
157
158 { # This operation resource represents operations that may have happened or are
159 # happening on the cluster. All fields are output only.
160 "status": "A String", # The current status of the operation.
161 "endTime": "A String", # [Output only] The time the operation completed, in
162 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
163 "name": "A String", # The server-assigned ID for the operation.
164 "zone": "A String", # The name of the Google Compute Engine
165 # [zone](/compute/docs/zones#available) in which the operation
166 # is taking place.
167 # This field is deprecated, use location instead.
168 "location": "A String", # [Output only] The name of the Google Compute Engine
169 # [zone](/compute/docs/regions-zones/regions-zones#available) or
170 # [region](/compute/docs/regions-zones/regions-zones#available) in which
171 # the cluster resides.
172 "startTime": "A String", # [Output only] The time the operation started, in
173 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
174 "detail": "A String", # Detailed operation progress, if available.
175 "clusterConditions": [ # Which conditions caused the current cluster state.
176 { # StatusCondition describes why a cluster or a node pool has a certain status
177 # (e.g., ERROR or DEGRADED).
178 "message": "A String", # Human-friendly representation of the condition
179 "code": "A String", # Machine-friendly representation of the condition
180 },
181 ],
182 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
183 "operationType": "A String", # The operation type.
184 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
185 "status": "A String", # Status of an operation stage.
186 # Unset for single-stage operations.
187 "metrics": [ # Progress metric bundle, for example:
188 # metrics: [{name: "nodes done", int_value: 15},
189 # {name: "nodes total", int_value: 32}]
190 # or
191 # metrics: [{name: "progress", double_value: 0.56},
192 # {name: "progress scale", double_value: 1.0}]
193 { # Progress metric is (string, int|float|string) pair.
194 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
195 "intValue": "A String", # For metrics with integer value.
196 "name": "A String", # Metric name, required.
197 # e.g., "nodes total", "percent done"
198 "doubleValue": 3.14, # For metrics with floating point value.
199 },
200 ],
201 "stages": [ # Substages of an operation or a stage.
202 # Object with schema name: OperationProgress
203 ],
204 "name": "A String", # A non-parameterized string describing an operation stage.
205 # Unset for single-stage operations.
206 },
207 "nodepoolConditions": [ # Which conditions caused the current node pool state.
208 { # StatusCondition describes why a cluster or a node pool has a certain status
209 # (e.g., ERROR or DEGRADED).
210 "message": "A String", # Human-friendly representation of the condition
211 "code": "A String", # Machine-friendly representation of the condition
212 },
213 ],
214 "selfLink": "A String", # Server-defined URL for the resource.
215 "targetLink": "A String", # Server-defined URL for the target of the operation.
216 }</pre>
217</div>
218
219<div class="method">
220 <code class="details" id="create">create(projectId, zone, clusterId, body, x__xgafv=None)</code>
221 <pre>Creates a node pool for a cluster.
222
223Args:
224 projectId: string, Deprecated. The Google Developers Console [project ID or project
225number](https://developers.google.com/console/help/new/#projectnumber).
226This field has been deprecated and replaced by the parent field. (required)
227 zone: string, Deprecated. The name of the Google Compute Engine
228[zone](/compute/docs/zones#available) in which the cluster
229resides.
230This field has been deprecated and replaced by the parent field. (required)
231 clusterId: string, Deprecated. The name of the cluster.
232This field has been deprecated and replaced by the parent field. (required)
233 body: object, The request body. (required)
234 The object takes the form of:
235
236{ # CreateNodePoolRequest creates a node pool for a cluster.
237 "parent": "A String", # The parent (project, location, cluster id) where the node pool will be
238 # created. Specified in the format
239 # 'projects/*/locations/*/clusters/*'.
240 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
241 # number](https://developers.google.com/console/help/new/#projectnumber).
242 # This field has been deprecated and replaced by the parent field.
243 "clusterId": "A String", # Deprecated. The name of the cluster.
244 # This field has been deprecated and replaced by the parent field.
245 "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # The node pool to create.
246 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
247 # specification, under the control of the cluster master. They may have a set
248 # of Kubernetes labels applied to them, which may be used to reference them
249 # during pod scheduling. They may also be resized up or down, to accommodate
250 # the workload.
251 "status": "A String", # [Output only] The status of the nodes in this pool instance.
252 "statusMessage": "A String", # [Output only] Additional information about the current status of this
253 # node pool instance, if available.
254 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
255 # node pool.
256 "autoRepair": True or False, # Whether the nodes will be automatically repaired.
257 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
258 # the Auto Upgrades will proceed.
259 "description": "A String", # [Output only] This field is set when upgrades are about to commence
260 # with the description of the upgrade.
261 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
262 # with the approximate start time for the upgrades, in
263 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
264 },
265 "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
266 },
267 "name": "A String", # The name of the node pool.
268 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
269 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances)
270 # associated with this node pool.
271 "A String",
272 ],
273 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
274 # only if a valid configuration is present.
275 # adjust the size of the node pool to the current cluster usage.
276 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=
277 # max_node_count.
278 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
279 "enabled": True or False, # Is autoscaling enabled for this node pool.
280 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There
281 # has to enough quota to scale up the cluster.
282 },
283 "locations": [ # The list of Google Compute Engine [zones](/compute/docs/zones#available)
284 # in which the NodePool's nodes should be located.
285 "A String",
286 ],
287 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
288 # simultaneously on a node in the node pool.
289 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
290 },
291 "version": "A String", # The version of the Kubernetes of this node.
292 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
293 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>
294 # is sufficient for this number of instances. You must also have available
295 # firewall and routes quota.
296 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
297 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
298 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
299 "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
300 },
301 "machineType": "A String", # The name of a Google Compute Engine [machine
302 # type](/compute/docs/machine-types) (e.g.
303 # `n1-standard-1`).
304 #
305 # If unspecified, the default machine type is
306 # `n1-standard-1`.
307 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
308 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
309 #
310 # Enables monitoring and attestation of the boot integrity of the instance.
311 # The attestation is performed against the integrity policy baseline. This
312 # baseline is initially derived from the implicitly trusted boot image when
313 # the instance is created.
314 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
315 #
316 # Secure Boot helps ensure that the system only runs authentic software by
317 # verifying the digital signature of all boot components, and halting the
318 # boot process if signature verification fails.
319 },
320 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
321 #
322 # If unspecified, the default disk type is 'pd-standard'
323 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
324 # valid sources or targets for network firewalls and are specified by
325 # the client during cluster or node pool creation. Each tag within the list
326 # must comply with RFC1035.
327 "A String",
328 ],
329 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
330 # https://cloud.google.com/compute/docs/instances/preemptible for more
331 # inforamtion about preemptible VM instances.
332 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
333 # These will added in addition to any default label(s) that
334 # Kubernetes may apply to the node.
335 # In case of conflict in label keys, the applied set may differ depending on
336 # the Kubernetes version -- it's best to assume the behavior is undefined
337 # and conflicts should be avoided.
338 # For more information, including usage and the valid values, see:
339 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
340 "a_key": "A String",
341 },
342 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If
343 # no Service Account is specified, the "default" service account is used.
344 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
345 # node VMs under the "default" service account.
346 #
347 # The following scopes are recommended, but not required, and by default are
348 # not included:
349 #
350 # * `https://www.googleapis.com/auth/compute` is required for mounting
351 # persistent storage on your nodes.
352 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
353 # communicating with **gcr.io**
354 # (the [Google Container Registry](/container-registry/)).
355 #
356 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
357 # Monitoring are enabled, in which case their required scopes will be added.
358 "A String",
359 ],
360 "taints": [ # List of kubernetes taints to be applied to each node.
361 #
362 # For more information, including usage and the valid values, see:
363 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
364 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
365 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
366 #
367 # For more information, including usage and the valid values, see:
368 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
369 "key": "A String", # Key for taint.
370 "effect": "A String", # Effect for taint.
371 "value": "A String", # Value for taint.
372 },
373 ],
374 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
375 # workloads on the node pool.
376 "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the
377 # workloads running on the node.
378 },
379 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
380 # The smallest allowed disk size is 10GB.
381 #
382 # If unspecified, the default disk size is 100GB.
383 "accelerators": [ # A list of hardware accelerators to be attached to each node.
384 # See https://cloud.google.com/compute/docs/gpus for more information about
385 # support for GPUs.
386 { # AcceleratorConfig represents a Hardware Accelerator request.
387 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
388 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
389 # [here](/compute/docs/gpus/#Introduction)
390 },
391 ],
392 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
393 # scheduled on the specified or newer CPU platform. Applicable values are the
394 # friendly names of CPU platforms, such as
395 # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or
396 # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more
397 # information, read [how to specify min CPU
398 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
399 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
400 #
401 # The limit for this value is dependant upon the maximum number of
402 # disks available on a machine per zone. See:
403 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits
404 # for more information.
405 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
406 # the latest version of it will be used.
407 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
408 #
409 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
410 # in length. These are reflected as part of a URL in the metadata server.
411 # Additionally, to avoid ambiguity, keys must not conflict with any other
412 # metadata keys for the project or be one of the reserved keys:
413 # "cluster-location"
414 # "cluster-name"
415 # "cluster-uid"
416 # "configure-sh"
417 # "containerd-configure-sh"
418 # "enable-oslogin"
419 # "gci-ensure-gke-docker"
420 # "gci-update-strategy"
421 # "instance-template"
422 # "kube-env"
423 # "startup-script"
424 # "user-data"
425 # "disable-address-manager"
426 # "windows-startup-script-ps1"
427 # "common-psm1"
428 # "k8s-node-setup-psm1"
429 # "install-ssh-psm1"
430 # "user-profile-psm1"
431 # "serial-port-logging-enable"
432 # Values are free-form strings, and only have meaning as interpreted by
433 # the image running in the instance. The only restriction placed on them is
434 # that each value's size must be less than or equal to 32 KB.
435 #
436 # The total size of all keys and values must be less than 512 KB.
437 "a_key": "A String",
438 },
439 },
440 "conditions": [ # Which conditions caused the current node pool state.
441 { # StatusCondition describes why a cluster or a node pool has a certain status
442 # (e.g., ERROR or DEGRADED).
443 "message": "A String", # Human-friendly representation of the condition
444 "code": "A String", # Machine-friendly representation of the condition
445 },
446 ],
447 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
448 },
449 "zone": "A String", # Deprecated. The name of the Google Compute Engine
450 # [zone](/compute/docs/zones#available) in which the cluster
451 # resides.
452 # This field has been deprecated and replaced by the parent field.
453 }
454
455 x__xgafv: string, V1 error format.
456 Allowed values
457 1 - v1 error format
458 2 - v2 error format
459
460Returns:
461 An object of the form:
462
463 { # This operation resource represents operations that may have happened or are
464 # happening on the cluster. All fields are output only.
465 "status": "A String", # The current status of the operation.
466 "endTime": "A String", # [Output only] The time the operation completed, in
467 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
468 "name": "A String", # The server-assigned ID for the operation.
469 "zone": "A String", # The name of the Google Compute Engine
470 # [zone](/compute/docs/zones#available) in which the operation
471 # is taking place.
472 # This field is deprecated, use location instead.
473 "location": "A String", # [Output only] The name of the Google Compute Engine
474 # [zone](/compute/docs/regions-zones/regions-zones#available) or
475 # [region](/compute/docs/regions-zones/regions-zones#available) in which
476 # the cluster resides.
477 "startTime": "A String", # [Output only] The time the operation started, in
478 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
479 "detail": "A String", # Detailed operation progress, if available.
480 "clusterConditions": [ # Which conditions caused the current cluster state.
481 { # StatusCondition describes why a cluster or a node pool has a certain status
482 # (e.g., ERROR or DEGRADED).
483 "message": "A String", # Human-friendly representation of the condition
484 "code": "A String", # Machine-friendly representation of the condition
485 },
486 ],
487 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
488 "operationType": "A String", # The operation type.
489 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
490 "status": "A String", # Status of an operation stage.
491 # Unset for single-stage operations.
492 "metrics": [ # Progress metric bundle, for example:
493 # metrics: [{name: "nodes done", int_value: 15},
494 # {name: "nodes total", int_value: 32}]
495 # or
496 # metrics: [{name: "progress", double_value: 0.56},
497 # {name: "progress scale", double_value: 1.0}]
498 { # Progress metric is (string, int|float|string) pair.
499 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
500 "intValue": "A String", # For metrics with integer value.
501 "name": "A String", # Metric name, required.
502 # e.g., "nodes total", "percent done"
503 "doubleValue": 3.14, # For metrics with floating point value.
504 },
505 ],
506 "stages": [ # Substages of an operation or a stage.
507 # Object with schema name: OperationProgress
508 ],
509 "name": "A String", # A non-parameterized string describing an operation stage.
510 # Unset for single-stage operations.
511 },
512 "nodepoolConditions": [ # Which conditions caused the current node pool state.
513 { # StatusCondition describes why a cluster or a node pool has a certain status
514 # (e.g., ERROR or DEGRADED).
515 "message": "A String", # Human-friendly representation of the condition
516 "code": "A String", # Machine-friendly representation of the condition
517 },
518 ],
519 "selfLink": "A String", # Server-defined URL for the resource.
520 "targetLink": "A String", # Server-defined URL for the target of the operation.
521 }</pre>
522</div>
523
524<div class="method">
525 <code class="details" id="delete">delete(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code>
526 <pre>Deletes a node pool from a cluster.
527
528Args:
529 projectId: string, Deprecated. The Google Developers Console [project ID or project
530number](https://developers.google.com/console/help/new/#projectnumber).
531This field has been deprecated and replaced by the name field. (required)
532 zone: string, Deprecated. The name of the Google Compute Engine
533[zone](/compute/docs/zones#available) in which the cluster
534resides.
535This field has been deprecated and replaced by the name field. (required)
536 clusterId: string, Deprecated. The name of the cluster.
537This field has been deprecated and replaced by the name field. (required)
538 nodePoolId: string, Deprecated. The name of the node pool to delete.
539This field has been deprecated and replaced by the name field. (required)
540 name: string, The name (project, location, cluster, node pool id) of the node pool to
541delete. Specified in the format
542'projects/*/locations/*/clusters/*/nodePools/*'.
543 x__xgafv: string, V1 error format.
544 Allowed values
545 1 - v1 error format
546 2 - v2 error format
547
548Returns:
549 An object of the form:
550
551 { # This operation resource represents operations that may have happened or are
552 # happening on the cluster. All fields are output only.
553 "status": "A String", # The current status of the operation.
554 "endTime": "A String", # [Output only] The time the operation completed, in
555 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
556 "name": "A String", # The server-assigned ID for the operation.
557 "zone": "A String", # The name of the Google Compute Engine
558 # [zone](/compute/docs/zones#available) in which the operation
559 # is taking place.
560 # This field is deprecated, use location instead.
561 "location": "A String", # [Output only] The name of the Google Compute Engine
562 # [zone](/compute/docs/regions-zones/regions-zones#available) or
563 # [region](/compute/docs/regions-zones/regions-zones#available) in which
564 # the cluster resides.
565 "startTime": "A String", # [Output only] The time the operation started, in
566 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
567 "detail": "A String", # Detailed operation progress, if available.
568 "clusterConditions": [ # Which conditions caused the current cluster state.
569 { # StatusCondition describes why a cluster or a node pool has a certain status
570 # (e.g., ERROR or DEGRADED).
571 "message": "A String", # Human-friendly representation of the condition
572 "code": "A String", # Machine-friendly representation of the condition
573 },
574 ],
575 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
576 "operationType": "A String", # The operation type.
577 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
578 "status": "A String", # Status of an operation stage.
579 # Unset for single-stage operations.
580 "metrics": [ # Progress metric bundle, for example:
581 # metrics: [{name: "nodes done", int_value: 15},
582 # {name: "nodes total", int_value: 32}]
583 # or
584 # metrics: [{name: "progress", double_value: 0.56},
585 # {name: "progress scale", double_value: 1.0}]
586 { # Progress metric is (string, int|float|string) pair.
587 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
588 "intValue": "A String", # For metrics with integer value.
589 "name": "A String", # Metric name, required.
590 # e.g., "nodes total", "percent done"
591 "doubleValue": 3.14, # For metrics with floating point value.
592 },
593 ],
594 "stages": [ # Substages of an operation or a stage.
595 # Object with schema name: OperationProgress
596 ],
597 "name": "A String", # A non-parameterized string describing an operation stage.
598 # Unset for single-stage operations.
599 },
600 "nodepoolConditions": [ # Which conditions caused the current node pool state.
601 { # StatusCondition describes why a cluster or a node pool has a certain status
602 # (e.g., ERROR or DEGRADED).
603 "message": "A String", # Human-friendly representation of the condition
604 "code": "A String", # Machine-friendly representation of the condition
605 },
606 ],
607 "selfLink": "A String", # Server-defined URL for the resource.
608 "targetLink": "A String", # Server-defined URL for the target of the operation.
609 }</pre>
610</div>
611
612<div class="method">
613 <code class="details" id="get">get(projectId, zone, clusterId, nodePoolId, name=None, x__xgafv=None)</code>
614 <pre>Retrieves the requested node pool.
615
616Args:
617 projectId: string, Deprecated. The Google Developers Console [project ID or project
618number](https://developers.google.com/console/help/new/#projectnumber).
619This field has been deprecated and replaced by the name field. (required)
620 zone: string, Deprecated. The name of the Google Compute Engine
621[zone](/compute/docs/zones#available) in which the cluster
622resides.
623This field has been deprecated and replaced by the name field. (required)
624 clusterId: string, Deprecated. The name of the cluster.
625This field has been deprecated and replaced by the name field. (required)
626 nodePoolId: string, Deprecated. The name of the node pool.
627This field has been deprecated and replaced by the name field. (required)
628 name: string, The name (project, location, cluster, node pool id) of the node pool to
629get. Specified in the format
630'projects/*/locations/*/clusters/*/nodePools/*'.
631 x__xgafv: string, V1 error format.
632 Allowed values
633 1 - v1 error format
634 2 - v2 error format
635
636Returns:
637 An object of the form:
638
639 { # NodePool contains the name and configuration for a cluster's node pool.
640 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
641 # specification, under the control of the cluster master. They may have a set
642 # of Kubernetes labels applied to them, which may be used to reference them
643 # during pod scheduling. They may also be resized up or down, to accommodate
644 # the workload.
645 "status": "A String", # [Output only] The status of the nodes in this pool instance.
646 "statusMessage": "A String", # [Output only] Additional information about the current status of this
647 # node pool instance, if available.
648 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
649 # node pool.
650 "autoRepair": True or False, # Whether the nodes will be automatically repaired.
651 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
652 # the Auto Upgrades will proceed.
653 "description": "A String", # [Output only] This field is set when upgrades are about to commence
654 # with the description of the upgrade.
655 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
656 # with the approximate start time for the upgrades, in
657 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
658 },
659 "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
660 },
661 "name": "A String", # The name of the node pool.
662 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
663 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances)
664 # associated with this node pool.
665 "A String",
666 ],
667 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
668 # only if a valid configuration is present.
669 # adjust the size of the node pool to the current cluster usage.
670 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=
671 # max_node_count.
672 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
673 "enabled": True or False, # Is autoscaling enabled for this node pool.
674 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There
675 # has to enough quota to scale up the cluster.
676 },
677 "locations": [ # The list of Google Compute Engine [zones](/compute/docs/zones#available)
678 # in which the NodePool's nodes should be located.
679 "A String",
680 ],
681 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
682 # simultaneously on a node in the node pool.
683 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
684 },
685 "version": "A String", # The version of the Kubernetes of this node.
686 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
687 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>
688 # is sufficient for this number of instances. You must also have available
689 # firewall and routes quota.
690 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
691 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
692 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
693 "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
694 },
695 "machineType": "A String", # The name of a Google Compute Engine [machine
696 # type](/compute/docs/machine-types) (e.g.
697 # `n1-standard-1`).
698 #
699 # If unspecified, the default machine type is
700 # `n1-standard-1`.
701 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
702 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
703 #
704 # Enables monitoring and attestation of the boot integrity of the instance.
705 # The attestation is performed against the integrity policy baseline. This
706 # baseline is initially derived from the implicitly trusted boot image when
707 # the instance is created.
708 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
709 #
710 # Secure Boot helps ensure that the system only runs authentic software by
711 # verifying the digital signature of all boot components, and halting the
712 # boot process if signature verification fails.
713 },
714 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
715 #
716 # If unspecified, the default disk type is 'pd-standard'
717 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
718 # valid sources or targets for network firewalls and are specified by
719 # the client during cluster or node pool creation. Each tag within the list
720 # must comply with RFC1035.
721 "A String",
722 ],
723 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
724 # https://cloud.google.com/compute/docs/instances/preemptible for more
725 # inforamtion about preemptible VM instances.
726 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
727 # These will added in addition to any default label(s) that
728 # Kubernetes may apply to the node.
729 # In case of conflict in label keys, the applied set may differ depending on
730 # the Kubernetes version -- it's best to assume the behavior is undefined
731 # and conflicts should be avoided.
732 # For more information, including usage and the valid values, see:
733 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
734 "a_key": "A String",
735 },
736 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If
737 # no Service Account is specified, the "default" service account is used.
738 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
739 # node VMs under the "default" service account.
740 #
741 # The following scopes are recommended, but not required, and by default are
742 # not included:
743 #
744 # * `https://www.googleapis.com/auth/compute` is required for mounting
745 # persistent storage on your nodes.
746 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
747 # communicating with **gcr.io**
748 # (the [Google Container Registry](/container-registry/)).
749 #
750 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
751 # Monitoring are enabled, in which case their required scopes will be added.
752 "A String",
753 ],
754 "taints": [ # List of kubernetes taints to be applied to each node.
755 #
756 # For more information, including usage and the valid values, see:
757 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
758 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
759 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
760 #
761 # For more information, including usage and the valid values, see:
762 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
763 "key": "A String", # Key for taint.
764 "effect": "A String", # Effect for taint.
765 "value": "A String", # Value for taint.
766 },
767 ],
768 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
769 # workloads on the node pool.
770 "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the
771 # workloads running on the node.
772 },
773 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
774 # The smallest allowed disk size is 10GB.
775 #
776 # If unspecified, the default disk size is 100GB.
777 "accelerators": [ # A list of hardware accelerators to be attached to each node.
778 # See https://cloud.google.com/compute/docs/gpus for more information about
779 # support for GPUs.
780 { # AcceleratorConfig represents a Hardware Accelerator request.
781 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
782 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
783 # [here](/compute/docs/gpus/#Introduction)
784 },
785 ],
786 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
787 # scheduled on the specified or newer CPU platform. Applicable values are the
788 # friendly names of CPU platforms, such as
789 # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or
790 # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more
791 # information, read [how to specify min CPU
792 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
793 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
794 #
795 # The limit for this value is dependant upon the maximum number of
796 # disks available on a machine per zone. See:
797 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits
798 # for more information.
799 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
800 # the latest version of it will be used.
801 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
802 #
803 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
804 # in length. These are reflected as part of a URL in the metadata server.
805 # Additionally, to avoid ambiguity, keys must not conflict with any other
806 # metadata keys for the project or be one of the reserved keys:
807 # "cluster-location"
808 # "cluster-name"
809 # "cluster-uid"
810 # "configure-sh"
811 # "containerd-configure-sh"
812 # "enable-oslogin"
813 # "gci-ensure-gke-docker"
814 # "gci-update-strategy"
815 # "instance-template"
816 # "kube-env"
817 # "startup-script"
818 # "user-data"
819 # "disable-address-manager"
820 # "windows-startup-script-ps1"
821 # "common-psm1"
822 # "k8s-node-setup-psm1"
823 # "install-ssh-psm1"
824 # "user-profile-psm1"
825 # "serial-port-logging-enable"
826 # Values are free-form strings, and only have meaning as interpreted by
827 # the image running in the instance. The only restriction placed on them is
828 # that each value's size must be less than or equal to 32 KB.
829 #
830 # The total size of all keys and values must be less than 512 KB.
831 "a_key": "A String",
832 },
833 },
834 "conditions": [ # Which conditions caused the current node pool state.
835 { # StatusCondition describes why a cluster or a node pool has a certain status
836 # (e.g., ERROR or DEGRADED).
837 "message": "A String", # Human-friendly representation of the condition
838 "code": "A String", # Machine-friendly representation of the condition
839 },
840 ],
841 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
842 }</pre>
843</div>
844
845<div class="method">
846 <code class="details" id="list">list(projectId, zone, clusterId, parent=None, x__xgafv=None)</code>
847 <pre>Lists the node pools for a cluster.
848
849Args:
850 projectId: string, Deprecated. The Google Developers Console [project ID or project
851number](https://developers.google.com/console/help/new/#projectnumber).
852This field has been deprecated and replaced by the parent field. (required)
853 zone: string, Deprecated. The name of the Google Compute Engine
854[zone](/compute/docs/zones#available) in which the cluster
855resides.
856This field has been deprecated and replaced by the parent field. (required)
857 clusterId: string, Deprecated. The name of the cluster.
858This field has been deprecated and replaced by the parent field. (required)
859 parent: string, The parent (project, location, cluster id) where the node pools will be
860listed. Specified in the format 'projects/*/locations/*/clusters/*'.
861 x__xgafv: string, V1 error format.
862 Allowed values
863 1 - v1 error format
864 2 - v2 error format
865
866Returns:
867 An object of the form:
868
869 { # ListNodePoolsResponse is the result of ListNodePoolsRequest.
870 "nodePools": [ # A list of node pools for a cluster.
871 { # NodePool contains the name and configuration for a cluster's node pool.
872 # Node pools are a set of nodes (i.e. VM's), with a common configuration and
873 # specification, under the control of the cluster master. They may have a set
874 # of Kubernetes labels applied to them, which may be used to reference them
875 # during pod scheduling. They may also be resized up or down, to accommodate
876 # the workload.
877 "status": "A String", # [Output only] The status of the nodes in this pool instance.
878 "statusMessage": "A String", # [Output only] Additional information about the current status of this
879 # node pool instance, if available.
880 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool.
881 # node pool.
882 "autoRepair": True or False, # Whether the nodes will be automatically repaired.
883 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
884 # the Auto Upgrades will proceed.
885 "description": "A String", # [Output only] This field is set when upgrades are about to commence
886 # with the description of the upgrade.
887 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
888 # with the approximate start time for the upgrades, in
889 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
890 },
891 "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
892 },
893 "name": "A String", # The name of the node pool.
894 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance
895 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances)
896 # associated with this node pool.
897 "A String",
898 ],
899 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled
900 # only if a valid configuration is present.
901 # adjust the size of the node pool to the current cluster usage.
902 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <=
903 # max_node_count.
904 "autoprovisioned": True or False, # Can this node pool be deleted automatically.
905 "enabled": True or False, # Is autoscaling enabled for this node pool.
906 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There
907 # has to enough quota to scale up the cluster.
908 },
909 "locations": [ # The list of Google Compute Engine [zones](/compute/docs/zones#available)
910 # in which the NodePool's nodes should be located.
911 "A String",
912 ],
913 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run
914 # simultaneously on a node in the node pool.
915 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
916 },
917 "version": "A String", # The version of the Kubernetes of this node.
918 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your
919 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a>
920 # is sufficient for this number of instances. You must also have available
921 # firewall and routes quota.
922 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
923 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool.
924 "sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
925 "sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
926 },
927 "machineType": "A String", # The name of a Google Compute Engine [machine
928 # type](/compute/docs/machine-types) (e.g.
929 # `n1-standard-1`).
930 #
931 # If unspecified, the default machine type is
932 # `n1-standard-1`.
933 "shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
934 "enableIntegrityMonitoring": True or False, # Defines whether the instance has integrity monitoring enabled.
935 #
936 # Enables monitoring and attestation of the boot integrity of the instance.
937 # The attestation is performed against the integrity policy baseline. This
938 # baseline is initially derived from the implicitly trusted boot image when
939 # the instance is created.
940 "enableSecureBoot": True or False, # Defines whether the instance has Secure Boot enabled.
941 #
942 # Secure Boot helps ensure that the system only runs authentic software by
943 # verifying the digital signature of all boot components, and halting the
944 # boot process if signature verification fails.
945 },
946 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')
947 #
948 # If unspecified, the default disk type is 'pd-standard'
949 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify
950 # valid sources or targets for network firewalls and are specified by
951 # the client during cluster or node pool creation. Each tag within the list
952 # must comply with RFC1035.
953 "A String",
954 ],
955 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See:
956 # https://cloud.google.com/compute/docs/instances/preemptible for more
957 # inforamtion about preemptible VM instances.
958 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node.
959 # These will added in addition to any default label(s) that
960 # Kubernetes may apply to the node.
961 # In case of conflict in label keys, the applied set may differ depending on
962 # the Kubernetes version -- it's best to assume the behavior is undefined
963 # and conflicts should be avoided.
964 # For more information, including usage and the valid values, see:
965 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
966 "a_key": "A String",
967 },
968 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If
969 # no Service Account is specified, the "default" service account is used.
970 "oauthScopes": [ # The set of Google API scopes to be made available on all of the
971 # node VMs under the "default" service account.
972 #
973 # The following scopes are recommended, but not required, and by default are
974 # not included:
975 #
976 # * `https://www.googleapis.com/auth/compute` is required for mounting
977 # persistent storage on your nodes.
978 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for
979 # communicating with **gcr.io**
980 # (the [Google Container Registry](/container-registry/)).
981 #
982 # If unspecified, no scopes are added, unless Cloud Logging or Cloud
983 # Monitoring are enabled, in which case their required scopes will be added.
984 "A String",
985 ],
986 "taints": [ # List of kubernetes taints to be applied to each node.
987 #
988 # For more information, including usage and the valid values, see:
989 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
990 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect
991 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
992 #
993 # For more information, including usage and the valid values, see:
994 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
995 "key": "A String", # Key for taint.
996 "effect": "A String", # Effect for taint.
997 "value": "A String", # Value for taint.
998 },
999 ],
1000 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The workload metadata configuration for this node.
1001 # workloads on the node pool.
1002 "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the
1003 # workloads running on the node.
1004 },
1005 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB.
1006 # The smallest allowed disk size is 10GB.
1007 #
1008 # If unspecified, the default disk size is 100GB.
1009 "accelerators": [ # A list of hardware accelerators to be attached to each node.
1010 # See https://cloud.google.com/compute/docs/gpus for more information about
1011 # support for GPUs.
1012 { # AcceleratorConfig represents a Hardware Accelerator request.
1013 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
1014 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators
1015 # [here](/compute/docs/gpus/#Introduction)
1016 },
1017 ],
1018 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be
1019 # scheduled on the specified or newer CPU platform. Applicable values are the
1020 # friendly names of CPU platforms, such as
1021 # <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or
1022 # <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more
1023 # information, read [how to specify min CPU
1024 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)
1025 "localSsdCount": 42, # The number of local SSD disks to be attached to the node.
1026 #
1027 # The limit for this value is dependant upon the maximum number of
1028 # disks available on a machine per zone. See:
1029 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits
1030 # for more information.
1031 "imageType": "A String", # The image type to use for this node. Note that for a given image type,
1032 # the latest version of it will be used.
1033 "metadata": { # The metadata key/value pairs assigned to instances in the cluster.
1034 #
1035 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes
1036 # in length. These are reflected as part of a URL in the metadata server.
1037 # Additionally, to avoid ambiguity, keys must not conflict with any other
1038 # metadata keys for the project or be one of the reserved keys:
1039 # "cluster-location"
1040 # "cluster-name"
1041 # "cluster-uid"
1042 # "configure-sh"
1043 # "containerd-configure-sh"
1044 # "enable-oslogin"
1045 # "gci-ensure-gke-docker"
1046 # "gci-update-strategy"
1047 # "instance-template"
1048 # "kube-env"
1049 # "startup-script"
1050 # "user-data"
1051 # "disable-address-manager"
1052 # "windows-startup-script-ps1"
1053 # "common-psm1"
1054 # "k8s-node-setup-psm1"
1055 # "install-ssh-psm1"
1056 # "user-profile-psm1"
1057 # "serial-port-logging-enable"
1058 # Values are free-form strings, and only have meaning as interpreted by
1059 # the image running in the instance. The only restriction placed on them is
1060 # that each value's size must be less than or equal to 32 KB.
1061 #
1062 # The total size of all keys and values must be less than 512 KB.
1063 "a_key": "A String",
1064 },
1065 },
1066 "conditions": [ # Which conditions caused the current node pool state.
1067 { # StatusCondition describes why a cluster or a node pool has a certain status
1068 # (e.g., ERROR or DEGRADED).
1069 "message": "A String", # Human-friendly representation of the condition
1070 "code": "A String", # Machine-friendly representation of the condition
1071 },
1072 ],
1073 "selfLink": "A String", # [Output only] Server-defined URL for the resource.
1074 },
1075 ],
1076 }</pre>
1077</div>
1078
1079<div class="method">
1080 <code class="details" id="rollback">rollback(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code>
1081 <pre>Rolls back a previously Aborted or Failed NodePool upgrade.
1082This makes no changes if the last upgrade successfully completed.
1083
1084Args:
1085 projectId: string, Deprecated. The Google Developers Console [project ID or project
1086number](https://support.google.com/cloud/answer/6158840).
1087This field has been deprecated and replaced by the name field. (required)
1088 zone: string, Deprecated. The name of the Google Compute Engine
1089[zone](/compute/docs/zones#available) in which the cluster
1090resides.
1091This field has been deprecated and replaced by the name field. (required)
1092 clusterId: string, Deprecated. The name of the cluster to rollback.
1093This field has been deprecated and replaced by the name field. (required)
1094 nodePoolId: string, Deprecated. The name of the node pool to rollback.
1095This field has been deprecated and replaced by the name field. (required)
1096 body: object, The request body. (required)
1097 The object takes the form of:
1098
1099{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed
1100 # NodePool upgrade. This will be an no-op if the last upgrade successfully
1101 # completed.
1102 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1103 # number](https://support.google.com/cloud/answer/6158840).
1104 # This field has been deprecated and replaced by the name field.
1105 "clusterId": "A String", # Deprecated. The name of the cluster to rollback.
1106 # This field has been deprecated and replaced by the name field.
1107 "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to
1108 # rollback upgrade.
1109 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
1110 "zone": "A String", # Deprecated. The name of the Google Compute Engine
1111 # [zone](/compute/docs/zones#available) in which the cluster
1112 # resides.
1113 # This field has been deprecated and replaced by the name field.
1114 "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback.
1115 # This field has been deprecated and replaced by the name field.
1116 }
1117
1118 x__xgafv: string, V1 error format.
1119 Allowed values
1120 1 - v1 error format
1121 2 - v2 error format
1122
1123Returns:
1124 An object of the form:
1125
1126 { # This operation resource represents operations that may have happened or are
1127 # happening on the cluster. All fields are output only.
1128 "status": "A String", # The current status of the operation.
1129 "endTime": "A String", # [Output only] The time the operation completed, in
1130 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1131 "name": "A String", # The server-assigned ID for the operation.
1132 "zone": "A String", # The name of the Google Compute Engine
1133 # [zone](/compute/docs/zones#available) in which the operation
1134 # is taking place.
1135 # This field is deprecated, use location instead.
1136 "location": "A String", # [Output only] The name of the Google Compute Engine
1137 # [zone](/compute/docs/regions-zones/regions-zones#available) or
1138 # [region](/compute/docs/regions-zones/regions-zones#available) in which
1139 # the cluster resides.
1140 "startTime": "A String", # [Output only] The time the operation started, in
1141 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1142 "detail": "A String", # Detailed operation progress, if available.
1143 "clusterConditions": [ # Which conditions caused the current cluster state.
1144 { # StatusCondition describes why a cluster or a node pool has a certain status
1145 # (e.g., ERROR or DEGRADED).
1146 "message": "A String", # Human-friendly representation of the condition
1147 "code": "A String", # Machine-friendly representation of the condition
1148 },
1149 ],
1150 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
1151 "operationType": "A String", # The operation type.
1152 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
1153 "status": "A String", # Status of an operation stage.
1154 # Unset for single-stage operations.
1155 "metrics": [ # Progress metric bundle, for example:
1156 # metrics: [{name: "nodes done", int_value: 15},
1157 # {name: "nodes total", int_value: 32}]
1158 # or
1159 # metrics: [{name: "progress", double_value: 0.56},
1160 # {name: "progress scale", double_value: 1.0}]
1161 { # Progress metric is (string, int|float|string) pair.
1162 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1163 "intValue": "A String", # For metrics with integer value.
1164 "name": "A String", # Metric name, required.
1165 # e.g., "nodes total", "percent done"
1166 "doubleValue": 3.14, # For metrics with floating point value.
1167 },
1168 ],
1169 "stages": [ # Substages of an operation or a stage.
1170 # Object with schema name: OperationProgress
1171 ],
1172 "name": "A String", # A non-parameterized string describing an operation stage.
1173 # Unset for single-stage operations.
1174 },
1175 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1176 { # StatusCondition describes why a cluster or a node pool has a certain status
1177 # (e.g., ERROR or DEGRADED).
1178 "message": "A String", # Human-friendly representation of the condition
1179 "code": "A String", # Machine-friendly representation of the condition
1180 },
1181 ],
1182 "selfLink": "A String", # Server-defined URL for the resource.
1183 "targetLink": "A String", # Server-defined URL for the target of the operation.
1184 }</pre>
1185</div>
1186
1187<div class="method">
1188 <code class="details" id="setManagement">setManagement(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code>
1189 <pre>Sets the NodeManagement options for a node pool.
1190
1191Args:
1192 projectId: string, Deprecated. The Google Developers Console [project ID or project
1193number](https://support.google.com/cloud/answer/6158840).
1194This field has been deprecated and replaced by the name field. (required)
1195 zone: string, Deprecated. The name of the Google Compute Engine
1196[zone](/compute/docs/zones#available) in which the cluster
1197resides.
1198This field has been deprecated and replaced by the name field. (required)
1199 clusterId: string, Deprecated. The name of the cluster to update.
1200This field has been deprecated and replaced by the name field. (required)
1201 nodePoolId: string, Deprecated. The name of the node pool to update.
1202This field has been deprecated and replaced by the name field. (required)
1203 body: object, The request body. (required)
1204 The object takes the form of:
1205
1206{ # SetNodePoolManagementRequest sets the node management properties of a node
1207 # pool.
1208 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for the node pool.
1209 # node pool.
1210 "autoRepair": True or False, # Whether the nodes will be automatically repaired.
1211 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool.
1212 # the Auto Upgrades will proceed.
1213 "description": "A String", # [Output only] This field is set when upgrades are about to commence
1214 # with the description of the upgrade.
1215 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence
1216 # with the approximate start time for the upgrades, in
1217 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1218 },
1219 "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
1220 },
1221 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set
1222 # management properties. Specified in the format
1223 # 'projects/*/locations/*/clusters/*/nodePools/*'.
1224 "zone": "A String", # Deprecated. The name of the Google Compute Engine
1225 # [zone](/compute/docs/zones#available) in which the cluster
1226 # resides.
1227 # This field has been deprecated and replaced by the name field.
1228 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1229 # number](https://support.google.com/cloud/answer/6158840).
1230 # This field has been deprecated and replaced by the name field.
1231 "clusterId": "A String", # Deprecated. The name of the cluster to update.
1232 # This field has been deprecated and replaced by the name field.
1233 "nodePoolId": "A String", # Deprecated. The name of the node pool to update.
1234 # This field has been deprecated and replaced by the name field.
1235 }
1236
1237 x__xgafv: string, V1 error format.
1238 Allowed values
1239 1 - v1 error format
1240 2 - v2 error format
1241
1242Returns:
1243 An object of the form:
1244
1245 { # This operation resource represents operations that may have happened or are
1246 # happening on the cluster. All fields are output only.
1247 "status": "A String", # The current status of the operation.
1248 "endTime": "A String", # [Output only] The time the operation completed, in
1249 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1250 "name": "A String", # The server-assigned ID for the operation.
1251 "zone": "A String", # The name of the Google Compute Engine
1252 # [zone](/compute/docs/zones#available) in which the operation
1253 # is taking place.
1254 # This field is deprecated, use location instead.
1255 "location": "A String", # [Output only] The name of the Google Compute Engine
1256 # [zone](/compute/docs/regions-zones/regions-zones#available) or
1257 # [region](/compute/docs/regions-zones/regions-zones#available) in which
1258 # the cluster resides.
1259 "startTime": "A String", # [Output only] The time the operation started, in
1260 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1261 "detail": "A String", # Detailed operation progress, if available.
1262 "clusterConditions": [ # Which conditions caused the current cluster state.
1263 { # StatusCondition describes why a cluster or a node pool has a certain status
1264 # (e.g., ERROR or DEGRADED).
1265 "message": "A String", # Human-friendly representation of the condition
1266 "code": "A String", # Machine-friendly representation of the condition
1267 },
1268 ],
1269 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
1270 "operationType": "A String", # The operation type.
1271 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
1272 "status": "A String", # Status of an operation stage.
1273 # Unset for single-stage operations.
1274 "metrics": [ # Progress metric bundle, for example:
1275 # metrics: [{name: "nodes done", int_value: 15},
1276 # {name: "nodes total", int_value: 32}]
1277 # or
1278 # metrics: [{name: "progress", double_value: 0.56},
1279 # {name: "progress scale", double_value: 1.0}]
1280 { # Progress metric is (string, int|float|string) pair.
1281 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1282 "intValue": "A String", # For metrics with integer value.
1283 "name": "A String", # Metric name, required.
1284 # e.g., "nodes total", "percent done"
1285 "doubleValue": 3.14, # For metrics with floating point value.
1286 },
1287 ],
1288 "stages": [ # Substages of an operation or a stage.
1289 # Object with schema name: OperationProgress
1290 ],
1291 "name": "A String", # A non-parameterized string describing an operation stage.
1292 # Unset for single-stage operations.
1293 },
1294 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1295 { # StatusCondition describes why a cluster or a node pool has a certain status
1296 # (e.g., ERROR or DEGRADED).
1297 "message": "A String", # Human-friendly representation of the condition
1298 "code": "A String", # Machine-friendly representation of the condition
1299 },
1300 ],
1301 "selfLink": "A String", # Server-defined URL for the resource.
1302 "targetLink": "A String", # Server-defined URL for the target of the operation.
1303 }</pre>
1304</div>
1305
1306<div class="method">
1307 <code class="details" id="setSize">setSize(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code>
1308 <pre>Sets the size for a specific node pool.
1309
1310Args:
1311 projectId: string, Deprecated. The Google Developers Console [project ID or project
1312number](https://support.google.com/cloud/answer/6158840).
1313This field has been deprecated and replaced by the name field. (required)
1314 zone: string, Deprecated. The name of the Google Compute Engine
1315[zone](/compute/docs/zones#available) in which the cluster
1316resides.
1317This field has been deprecated and replaced by the name field. (required)
1318 clusterId: string, Deprecated. The name of the cluster to update.
1319This field has been deprecated and replaced by the name field. (required)
1320 nodePoolId: string, Deprecated. The name of the node pool to update.
1321This field has been deprecated and replaced by the name field. (required)
1322 body: object, The request body. (required)
1323 The object takes the form of:
1324
1325{ # SetNodePoolSizeRequest sets the size a node
1326 # pool.
1327 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set
1328 # size.
1329 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.
1330 "zone": "A String", # Deprecated. The name of the Google Compute Engine
1331 # [zone](/compute/docs/zones#available) in which the cluster
1332 # resides.
1333 # This field has been deprecated and replaced by the name field.
1334 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1335 # number](https://support.google.com/cloud/answer/6158840).
1336 # This field has been deprecated and replaced by the name field.
1337 "clusterId": "A String", # Deprecated. The name of the cluster to update.
1338 # This field has been deprecated and replaced by the name field.
1339 "nodePoolId": "A String", # Deprecated. The name of the node pool to update.
1340 # This field has been deprecated and replaced by the name field.
1341 "nodeCount": 42, # The desired node count for the pool.
1342 }
1343
1344 x__xgafv: string, V1 error format.
1345 Allowed values
1346 1 - v1 error format
1347 2 - v2 error format
1348
1349Returns:
1350 An object of the form:
1351
1352 { # This operation resource represents operations that may have happened or are
1353 # happening on the cluster. All fields are output only.
1354 "status": "A String", # The current status of the operation.
1355 "endTime": "A String", # [Output only] The time the operation completed, in
1356 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1357 "name": "A String", # The server-assigned ID for the operation.
1358 "zone": "A String", # The name of the Google Compute Engine
1359 # [zone](/compute/docs/zones#available) in which the operation
1360 # is taking place.
1361 # This field is deprecated, use location instead.
1362 "location": "A String", # [Output only] The name of the Google Compute Engine
1363 # [zone](/compute/docs/regions-zones/regions-zones#available) or
1364 # [region](/compute/docs/regions-zones/regions-zones#available) in which
1365 # the cluster resides.
1366 "startTime": "A String", # [Output only] The time the operation started, in
1367 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1368 "detail": "A String", # Detailed operation progress, if available.
1369 "clusterConditions": [ # Which conditions caused the current cluster state.
1370 { # StatusCondition describes why a cluster or a node pool has a certain status
1371 # (e.g., ERROR or DEGRADED).
1372 "message": "A String", # Human-friendly representation of the condition
1373 "code": "A String", # Machine-friendly representation of the condition
1374 },
1375 ],
1376 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
1377 "operationType": "A String", # The operation type.
1378 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
1379 "status": "A String", # Status of an operation stage.
1380 # Unset for single-stage operations.
1381 "metrics": [ # Progress metric bundle, for example:
1382 # metrics: [{name: "nodes done", int_value: 15},
1383 # {name: "nodes total", int_value: 32}]
1384 # or
1385 # metrics: [{name: "progress", double_value: 0.56},
1386 # {name: "progress scale", double_value: 1.0}]
1387 { # Progress metric is (string, int|float|string) pair.
1388 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1389 "intValue": "A String", # For metrics with integer value.
1390 "name": "A String", # Metric name, required.
1391 # e.g., "nodes total", "percent done"
1392 "doubleValue": 3.14, # For metrics with floating point value.
1393 },
1394 ],
1395 "stages": [ # Substages of an operation or a stage.
1396 # Object with schema name: OperationProgress
1397 ],
1398 "name": "A String", # A non-parameterized string describing an operation stage.
1399 # Unset for single-stage operations.
1400 },
1401 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1402 { # StatusCondition describes why a cluster or a node pool has a certain status
1403 # (e.g., ERROR or DEGRADED).
1404 "message": "A String", # Human-friendly representation of the condition
1405 "code": "A String", # Machine-friendly representation of the condition
1406 },
1407 ],
1408 "selfLink": "A String", # Server-defined URL for the resource.
1409 "targetLink": "A String", # Server-defined URL for the target of the operation.
1410 }</pre>
1411</div>
1412
1413<div class="method">
1414 <code class="details" id="update">update(projectId, zone, clusterId, nodePoolId, body, x__xgafv=None)</code>
1415 <pre>Updates the version and/or image type of a specific node pool.
1416
1417Args:
1418 projectId: string, Deprecated. The Google Developers Console [project ID or project
1419number](https://support.google.com/cloud/answer/6158840).
1420This field has been deprecated and replaced by the name field. (required)
1421 zone: string, Deprecated. The name of the Google Compute Engine
1422[zone](/compute/docs/zones#available) in which the cluster
1423resides.
1424This field has been deprecated and replaced by the name field. (required)
1425 clusterId: string, Deprecated. The name of the cluster to upgrade.
1426This field has been deprecated and replaced by the name field. (required)
1427 nodePoolId: string, Deprecated. The name of the node pool to upgrade.
1428This field has been deprecated and replaced by the name field. (required)
1429 body: object, The request body. (required)
1430 The object takes the form of:
1431
1432{ # SetNodePoolVersionRequest updates the version of a node pool.
1433 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to
1434 # update. Specified in the format
1435 # 'projects/*/locations/*/clusters/*/nodePools/*'.
1436 "zone": "A String", # Deprecated. The name of the Google Compute Engine
1437 # [zone](/compute/docs/zones#available) in which the cluster
1438 # resides.
1439 # This field has been deprecated and replaced by the name field.
1440 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project
1441 # number](https://support.google.com/cloud/answer/6158840).
1442 # This field has been deprecated and replaced by the name field.
1443 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade.
1444 # This field has been deprecated and replaced by the name field.
1445 "locations": [ # The desired list of Google Compute Engine
1446 # [zones](/compute/docs/zones#available) in which the node pool's nodes
1447 # should be located. Changing the locations for a node pool will result
1448 # in nodes being either created or removed from the node pool, depending
1449 # on whether locations are being added or removed.
1450 "A String",
1451 ],
1452 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade.
1453 # This field has been deprecated and replaced by the name field.
1454 "workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to # The desired image type for the node pool.
1455 # workloads on the node pool.
1456 "nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the
1457 # workloads running on the node.
1458 },
1459 "nodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an
1460 # upgrade).
1461 #
1462 # Users may specify either explicit versions offered by Kubernetes Engine or
1463 # version aliases, which have the following behavior:
1464 #
1465 # - "latest": picks the highest valid Kubernetes version
1466 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version
1467 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
1468 # - "1.X.Y-gke.N": picks an explicit Kubernetes version
1469 # - "-": picks the Kubernetes master version
1470 "imageType": "A String", # The desired image type for the node pool.
1471 }
1472
1473 x__xgafv: string, V1 error format.
1474 Allowed values
1475 1 - v1 error format
1476 2 - v2 error format
1477
1478Returns:
1479 An object of the form:
1480
1481 { # This operation resource represents operations that may have happened or are
1482 # happening on the cluster. All fields are output only.
1483 "status": "A String", # The current status of the operation.
1484 "endTime": "A String", # [Output only] The time the operation completed, in
1485 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1486 "name": "A String", # The server-assigned ID for the operation.
1487 "zone": "A String", # The name of the Google Compute Engine
1488 # [zone](/compute/docs/zones#available) in which the operation
1489 # is taking place.
1490 # This field is deprecated, use location instead.
1491 "location": "A String", # [Output only] The name of the Google Compute Engine
1492 # [zone](/compute/docs/regions-zones/regions-zones#available) or
1493 # [region](/compute/docs/regions-zones/regions-zones#available) in which
1494 # the cluster resides.
1495 "startTime": "A String", # [Output only] The time the operation started, in
1496 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
1497 "detail": "A String", # Detailed operation progress, if available.
1498 "clusterConditions": [ # Which conditions caused the current cluster state.
1499 { # StatusCondition describes why a cluster or a node pool has a certain status
1500 # (e.g., ERROR or DEGRADED).
1501 "message": "A String", # Human-friendly representation of the condition
1502 "code": "A String", # Machine-friendly representation of the condition
1503 },
1504 ],
1505 "statusMessage": "A String", # If an error has occurred, a textual description of the error.
1506 "operationType": "A String", # The operation type.
1507 "progress": { # Information about operation (or operation stage) progress. # [Output only] Progress information for an operation.
1508 "status": "A String", # Status of an operation stage.
1509 # Unset for single-stage operations.
1510 "metrics": [ # Progress metric bundle, for example:
1511 # metrics: [{name: "nodes done", int_value: 15},
1512 # {name: "nodes total", int_value: 32}]
1513 # or
1514 # metrics: [{name: "progress", double_value: 0.56},
1515 # {name: "progress scale", double_value: 1.0}]
1516 { # Progress metric is (string, int|float|string) pair.
1517 "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
1518 "intValue": "A String", # For metrics with integer value.
1519 "name": "A String", # Metric name, required.
1520 # e.g., "nodes total", "percent done"
1521 "doubleValue": 3.14, # For metrics with floating point value.
1522 },
1523 ],
1524 "stages": [ # Substages of an operation or a stage.
1525 # Object with schema name: OperationProgress
1526 ],
1527 "name": "A String", # A non-parameterized string describing an operation stage.
1528 # Unset for single-stage operations.
1529 },
1530 "nodepoolConditions": [ # Which conditions caused the current node pool state.
1531 { # StatusCondition describes why a cluster or a node pool has a certain status
1532 # (e.g., ERROR or DEGRADED).
1533 "message": "A String", # Human-friendly representation of the condition
1534 "code": "A String", # Machine-friendly representation of the condition
1535 },
1536 ],
1537 "selfLink": "A String", # Server-defined URL for the resource.
1538 "targetLink": "A String", # Server-defined URL for the target of the operation.
1539 }</pre>
1540</div>
1541
1542</body></html>