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