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"> 78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> 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"> 90 <code><a href="#rollback">rollback(name, body, x__xgafv=None)</a></code></p> 91<p class="firstline">Rolls back a previously Aborted or Failed NodePool upgrade.</p> 92<p class="toc_element"> 93 <code><a href="#setAutoscaling">setAutoscaling(name, body, x__xgafv=None)</a></code></p> 94<p class="firstline">Sets the autoscaling settings for the specified node pool.</p> 95<p class="toc_element"> 96 <code><a href="#setManagement">setManagement(name, body, x__xgafv=None)</a></code></p> 97<p class="firstline">Sets the NodeManagement options for a node pool.</p> 98<p class="toc_element"> 99 <code><a href="#setSize">setSize(name, body, x__xgafv=None)</a></code></p> 100<p class="firstline">Sets the size for a specific node pool.</p> 101<p class="toc_element"> 102 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p> 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"> 106 <code class="details" id="create">create(parent, body, x__xgafv=None)</code> 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) 113 body: object, The request body. (required) 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. 125 "nodePool": { # NodePool contains the name and configuration for a cluster's node pool. # The node pool to create. 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. 132 "statusMessage": "A String", # [Output only] Additional information about the current status of this 133 # node pool instance, if available. 134 "name": "A String", # The name of the node pool. 135 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance 136 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) 137 # associated with this node pool. 138 "A String", 139 ], 140 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 141 # only if a valid configuration is present. 142 # adjust the size of the node pool to the current cluster usage. 143 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 144 # max_node_count. 145 "enabled": True or False, # Is autoscaling enabled for this node pool. 146 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 147 # has to enough quota to scale up the cluster. 148 }, 149 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run 150 # simultaneously on a node in the node pool. 151 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. 152 }, 153 "version": "A String", # The version of the Kubernetes of this node. 154 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 155 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 156 # is sufficient for this number of instances. You must also have available 157 # firewall and routes quota. 158 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. 159 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 160 # node pool. 161 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 162 # pool. If enabled, the nodes in this node pool will be monitored and, if 163 # they fail health checks too many times, an automatic repair action will be 164 # triggered. 165 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 166 # the Auto Upgrades will proceed. 167 "description": "A String", # [Output only] This field is set when upgrades are about to commence 168 # with the description of the upgrade. 169 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 170 # with the approximate start time for the upgrades, in 171 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 172 }, 173 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 174 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 175 # up to date with the latest release version of Kubernetes. 176 }, 177 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 178 "taints": [ # List of kubernetes taints to be applied to each node. 179 # 180 # For more information, including usage and the valid values, see: 181 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 182 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect 183 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. 184 # 185 # For more information, including usage and the valid values, see: 186 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 187 "key": "A String", # Key for taint. 188 "effect": "A String", # Effect for taint. 189 "value": "A String", # Value for taint. 190 }, 191 ], 192 "machineType": "A String", # The name of a Google Compute Engine [machine 193 # type](/compute/docs/machine-types) (e.g. 194 # `n1-standard-1`). 195 # 196 # If unspecified, the default machine type is 197 # `n1-standard-1`. 198 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 199 # valid sources or targets for network firewalls and are specified by 200 # the client during cluster or node pool creation. Each tag within the list 201 # must comply with RFC1035. 202 "A String", 203 ], 204 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 205 # https://cloud.google.com/compute/docs/instances/preemptible for more 206 # information about preemptible VM instances. 207 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 208 # These will added in addition to any default label(s) that 209 # Kubernetes may apply to the node. 210 # In case of conflict in label keys, the applied set may differ depending on 211 # the Kubernetes version -- it's best to assume the behavior is undefined 212 # and conflicts should be avoided. 213 # For more information, including usage and the valid values, see: 214 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ 215 "a_key": "A String", 216 }, 217 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 218 # no Service Account is specified, the "default" service account is used. 219 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 220 # node VMs under the "default" service account. 221 # 222 # The following scopes are recommended, but not required, and by default are 223 # not included: 224 # 225 # * `https://www.googleapis.com/auth/compute` is required for mounting 226 # persistent storage on your nodes. 227 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 228 # communicating with **gcr.io** 229 # (the [Google Container Registry](/container-registry/)). 230 # 231 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 232 # Monitoring are enabled, in which case their required scopes will be added. 233 "A String", 234 ], 235 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') 236 # 237 # If unspecified, the default disk type is 'pd-standard' 238 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 239 # The smallest allowed disk size is 10GB. 240 # 241 # If unspecified, the default disk size is 100GB. 242 "accelerators": [ # A list of hardware accelerators to be attached to each node. 243 # See https://cloud.google.com/compute/docs/gpus for more information about 244 # support for GPUs. 245 { # AcceleratorConfig represents a Hardware Accelerator request. 246 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. 247 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators 248 # [here](/compute/docs/gpus/#Introduction) 249 }, 250 ], 251 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be 252 # scheduled on the specified or newer CPU platform. Applicable values are the 253 # friendly names of CPU platforms, such as 254 # <code>minCpuPlatform: "Intel Haswell"</code> or 255 # <code>minCpuPlatform: "Intel Sandy Bridge"</code>. For more 256 # information, read [how to specify min CPU 257 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) 258 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 259 # 260 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 261 # in length. These are reflected as part of a URL in the metadata server. 262 # Additionally, to avoid ambiguity, keys must not conflict with any other 263 # metadata keys for the project or be one of the reserved keys: 264 # "cluster-location" 265 # "cluster-name" 266 # "cluster-uid" 267 # "configure-sh" 268 # "containerd-configure-sh" 269 # "enable-os-login" 270 # "gci-update-strategy" 271 # "gci-ensure-gke-docker" 272 # "instance-template" 273 # "kube-env" 274 # "startup-script" 275 # "user-data" 276 # "disable-address-manager" 277 # "windows-startup-script-ps1" 278 # "common-psm1" 279 # "k8s-node-setup-psm1" 280 # "install-ssh-psm1" 281 # "user-profile-psm1" 282 # "serial-port-logging-enable" 283 # 284 # Values are free-form strings, and only have meaning as interpreted by 285 # the image running in the instance. The only restriction placed on them is 286 # that each value's size must be less than or equal to 32 KB. 287 # 288 # The total size of all keys and values must be less than 512 KB. 289 "a_key": "A String", 290 }, 291 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 292 # the latest version of it will be used. 293 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 294 # 295 # The limit for this value is dependant upon the maximum number of 296 # disks available on a machine per zone. See: 297 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 298 # for more information. 299 }, 300 "conditions": [ # Which conditions caused the current node pool state. 301 { # StatusCondition describes why a cluster or a node pool has a certain status 302 # (e.g., ERROR or DEGRADED). 303 "message": "A String", # Human-friendly representation of the condition 304 "code": "A String", # Machine-friendly representation of the condition 305 }, 306 ], 307 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 308 }, 309 "zone": "A String", # Deprecated. The name of the Google Compute Engine 310 # [zone](/compute/docs/zones#available) in which the cluster 311 # resides. 312 # This field has been deprecated and replaced by the parent field. 313 } 314 315 x__xgafv: string, V1 error format. 316 Allowed values 317 1 - v1 error format 318 2 - v2 error format 319 320Returns: 321 An object of the form: 322 323 { # This operation resource represents operations that may have happened or are 324 # happening on the cluster. All fields are output only. 325 "status": "A String", # The current status of the operation. 326 "selfLink": "A String", # Server-defined URL for the resource. 327 "name": "A String", # The server-assigned ID for the operation. 328 "zone": "A String", # The name of the Google Compute Engine 329 # [zone](/compute/docs/zones#available) in which the operation 330 # is taking place. 331 # This field is deprecated, use location instead. 332 "startTime": "A String", # [Output only] The time the operation started, in 333 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 334 "detail": "A String", # Detailed operation progress, if available. 335 "operationType": "A String", # The operation type. 336 "targetLink": "A String", # Server-defined URL for the target of the operation. 337 "location": "A String", # [Output only] The name of the Google Compute Engine 338 # [zone](/compute/docs/regions-zones/regions-zones#available) or 339 # [region](/compute/docs/regions-zones/regions-zones#available) in which 340 # the cluster resides. 341 "nodepoolConditions": [ # Which conditions caused the current node pool state. 342 { # StatusCondition describes why a cluster or a node pool has a certain status 343 # (e.g., ERROR or DEGRADED). 344 "message": "A String", # Human-friendly representation of the condition 345 "code": "A String", # Machine-friendly representation of the condition 346 }, 347 ], 348 "endTime": "A String", # [Output only] The time the operation completed, in 349 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 350 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 351 "clusterConditions": [ # Which conditions caused the current cluster state. 352 { # StatusCondition describes why a cluster or a node pool has a certain status 353 # (e.g., ERROR or DEGRADED). 354 "message": "A String", # Human-friendly representation of the condition 355 "code": "A String", # Machine-friendly representation of the condition 356 }, 357 ], 358 }</pre> 359</div> 360 361<div class="method"> 362 <code class="details" id="delete">delete(name, zone=None, projectId=None, clusterId=None, nodePoolId=None, x__xgafv=None)</code> 363 <pre>Deletes a node pool from a cluster. 364 365Args: 366 name: string, The name (project, location, cluster, node pool id) of the node pool to 367delete. Specified in the format 368'projects/*/locations/*/clusters/*/nodePools/*'. (required) 369 zone: string, Deprecated. The name of the Google Compute Engine 370[zone](/compute/docs/zones#available) in which the cluster 371resides. 372This field has been deprecated and replaced by the name field. 373 projectId: string, Deprecated. The Google Developers Console [project ID or project 374number](https://developers.google.com/console/help/new/#projectnumber). 375This field has been deprecated and replaced by the name field. 376 clusterId: string, Deprecated. The name of the cluster. 377This field has been deprecated and replaced by the name field. 378 nodePoolId: string, Deprecated. The name of the node pool to delete. 379This field has been deprecated and replaced by the name field. 380 x__xgafv: string, V1 error format. 381 Allowed values 382 1 - v1 error format 383 2 - v2 error format 384 385Returns: 386 An object of the form: 387 388 { # This operation resource represents operations that may have happened or are 389 # happening on the cluster. All fields are output only. 390 "status": "A String", # The current status of the operation. 391 "selfLink": "A String", # Server-defined URL for the resource. 392 "name": "A String", # The server-assigned ID for the operation. 393 "zone": "A String", # The name of the Google Compute Engine 394 # [zone](/compute/docs/zones#available) in which the operation 395 # is taking place. 396 # This field is deprecated, use location instead. 397 "startTime": "A String", # [Output only] The time the operation started, in 398 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 399 "detail": "A String", # Detailed operation progress, if available. 400 "operationType": "A String", # The operation type. 401 "targetLink": "A String", # Server-defined URL for the target of the operation. 402 "location": "A String", # [Output only] The name of the Google Compute Engine 403 # [zone](/compute/docs/regions-zones/regions-zones#available) or 404 # [region](/compute/docs/regions-zones/regions-zones#available) in which 405 # the cluster resides. 406 "nodepoolConditions": [ # Which conditions caused the current node pool state. 407 { # StatusCondition describes why a cluster or a node pool has a certain status 408 # (e.g., ERROR or DEGRADED). 409 "message": "A String", # Human-friendly representation of the condition 410 "code": "A String", # Machine-friendly representation of the condition 411 }, 412 ], 413 "endTime": "A String", # [Output only] The time the operation completed, in 414 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 415 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 416 "clusterConditions": [ # Which conditions caused the current cluster state. 417 { # StatusCondition describes why a cluster or a node pool has a certain status 418 # (e.g., ERROR or DEGRADED). 419 "message": "A String", # Human-friendly representation of the condition 420 "code": "A String", # Machine-friendly representation of the condition 421 }, 422 ], 423 }</pre> 424</div> 425 426<div class="method"> 427 <code class="details" id="get">get(name, zone=None, projectId=None, clusterId=None, nodePoolId=None, x__xgafv=None)</code> 428 <pre>Retrieves the requested node pool. 429 430Args: 431 name: string, The name (project, location, cluster, node pool id) of the node pool to 432get. Specified in the format 433'projects/*/locations/*/clusters/*/nodePools/*'. (required) 434 zone: string, Deprecated. The name of the Google Compute Engine 435[zone](/compute/docs/zones#available) in which the cluster 436resides. 437This field has been deprecated and replaced by the name field. 438 projectId: string, Deprecated. The Google Developers Console [project ID or project 439number](https://developers.google.com/console/help/new/#projectnumber). 440This field has been deprecated and replaced by the name field. 441 clusterId: string, Deprecated. The name of the cluster. 442This field has been deprecated and replaced by the name field. 443 nodePoolId: string, Deprecated. The name of the node pool. 444This field has been deprecated and replaced by the name field. 445 x__xgafv: string, V1 error format. 446 Allowed values 447 1 - v1 error format 448 2 - v2 error format 449 450Returns: 451 An object of the form: 452 453 { # NodePool contains the name and configuration for a cluster's node pool. 454 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 455 # specification, under the control of the cluster master. They may have a set 456 # of Kubernetes labels applied to them, which may be used to reference them 457 # during pod scheduling. They may also be resized up or down, to accommodate 458 # the workload. 459 "status": "A String", # [Output only] The status of the nodes in this pool instance. 460 "statusMessage": "A String", # [Output only] Additional information about the current status of this 461 # node pool instance, if available. 462 "name": "A String", # The name of the node pool. 463 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance 464 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) 465 # associated with this node pool. 466 "A String", 467 ], 468 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 469 # only if a valid configuration is present. 470 # adjust the size of the node pool to the current cluster usage. 471 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 472 # max_node_count. 473 "enabled": True or False, # Is autoscaling enabled for this node pool. 474 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 475 # has to enough quota to scale up the cluster. 476 }, 477 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run 478 # simultaneously on a node in the node pool. 479 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. 480 }, 481 "version": "A String", # The version of the Kubernetes of this node. 482 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 483 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 484 # is sufficient for this number of instances. You must also have available 485 # firewall and routes quota. 486 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. 487 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 488 # node pool. 489 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 490 # pool. If enabled, the nodes in this node pool will be monitored and, if 491 # they fail health checks too many times, an automatic repair action will be 492 # triggered. 493 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 494 # the Auto Upgrades will proceed. 495 "description": "A String", # [Output only] This field is set when upgrades are about to commence 496 # with the description of the upgrade. 497 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 498 # with the approximate start time for the upgrades, in 499 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 500 }, 501 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 502 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 503 # up to date with the latest release version of Kubernetes. 504 }, 505 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 506 "taints": [ # List of kubernetes taints to be applied to each node. 507 # 508 # For more information, including usage and the valid values, see: 509 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 510 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect 511 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. 512 # 513 # For more information, including usage and the valid values, see: 514 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 515 "key": "A String", # Key for taint. 516 "effect": "A String", # Effect for taint. 517 "value": "A String", # Value for taint. 518 }, 519 ], 520 "machineType": "A String", # The name of a Google Compute Engine [machine 521 # type](/compute/docs/machine-types) (e.g. 522 # `n1-standard-1`). 523 # 524 # If unspecified, the default machine type is 525 # `n1-standard-1`. 526 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 527 # valid sources or targets for network firewalls and are specified by 528 # the client during cluster or node pool creation. Each tag within the list 529 # must comply with RFC1035. 530 "A String", 531 ], 532 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 533 # https://cloud.google.com/compute/docs/instances/preemptible for more 534 # information about preemptible VM instances. 535 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 536 # These will added in addition to any default label(s) that 537 # Kubernetes may apply to the node. 538 # In case of conflict in label keys, the applied set may differ depending on 539 # the Kubernetes version -- it's best to assume the behavior is undefined 540 # and conflicts should be avoided. 541 # For more information, including usage and the valid values, see: 542 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ 543 "a_key": "A String", 544 }, 545 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 546 # no Service Account is specified, the "default" service account is used. 547 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 548 # node VMs under the "default" service account. 549 # 550 # The following scopes are recommended, but not required, and by default are 551 # not included: 552 # 553 # * `https://www.googleapis.com/auth/compute` is required for mounting 554 # persistent storage on your nodes. 555 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 556 # communicating with **gcr.io** 557 # (the [Google Container Registry](/container-registry/)). 558 # 559 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 560 # Monitoring are enabled, in which case their required scopes will be added. 561 "A String", 562 ], 563 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') 564 # 565 # If unspecified, the default disk type is 'pd-standard' 566 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 567 # The smallest allowed disk size is 10GB. 568 # 569 # If unspecified, the default disk size is 100GB. 570 "accelerators": [ # A list of hardware accelerators to be attached to each node. 571 # See https://cloud.google.com/compute/docs/gpus for more information about 572 # support for GPUs. 573 { # AcceleratorConfig represents a Hardware Accelerator request. 574 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. 575 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators 576 # [here](/compute/docs/gpus/#Introduction) 577 }, 578 ], 579 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be 580 # scheduled on the specified or newer CPU platform. Applicable values are the 581 # friendly names of CPU platforms, such as 582 # <code>minCpuPlatform: "Intel Haswell"</code> or 583 # <code>minCpuPlatform: "Intel Sandy Bridge"</code>. For more 584 # information, read [how to specify min CPU 585 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) 586 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 587 # 588 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 589 # in length. These are reflected as part of a URL in the metadata server. 590 # Additionally, to avoid ambiguity, keys must not conflict with any other 591 # metadata keys for the project or be one of the reserved keys: 592 # "cluster-location" 593 # "cluster-name" 594 # "cluster-uid" 595 # "configure-sh" 596 # "containerd-configure-sh" 597 # "enable-os-login" 598 # "gci-update-strategy" 599 # "gci-ensure-gke-docker" 600 # "instance-template" 601 # "kube-env" 602 # "startup-script" 603 # "user-data" 604 # "disable-address-manager" 605 # "windows-startup-script-ps1" 606 # "common-psm1" 607 # "k8s-node-setup-psm1" 608 # "install-ssh-psm1" 609 # "user-profile-psm1" 610 # "serial-port-logging-enable" 611 # 612 # Values are free-form strings, and only have meaning as interpreted by 613 # the image running in the instance. The only restriction placed on them is 614 # that each value's size must be less than or equal to 32 KB. 615 # 616 # The total size of all keys and values must be less than 512 KB. 617 "a_key": "A String", 618 }, 619 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 620 # the latest version of it will be used. 621 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 622 # 623 # The limit for this value is dependant upon the maximum number of 624 # disks available on a machine per zone. See: 625 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 626 # for more information. 627 }, 628 "conditions": [ # Which conditions caused the current node pool state. 629 { # StatusCondition describes why a cluster or a node pool has a certain status 630 # (e.g., ERROR or DEGRADED). 631 "message": "A String", # Human-friendly representation of the condition 632 "code": "A String", # Machine-friendly representation of the condition 633 }, 634 ], 635 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 636 }</pre> 637</div> 638 639<div class="method"> 640 <code class="details" id="list">list(parent, projectId=None, clusterId=None, zone=None, x__xgafv=None)</code> 641 <pre>Lists the node pools for a cluster. 642 643Args: 644 parent: string, The parent (project, location, cluster id) where the node pools will be 645listed. Specified in the format 'projects/*/locations/*/clusters/*'. (required) 646 projectId: string, Deprecated. The Google Developers Console [project ID or project 647number](https://developers.google.com/console/help/new/#projectnumber). 648This field has been deprecated and replaced by the parent field. 649 clusterId: string, Deprecated. The name of the cluster. 650This field has been deprecated and replaced by the parent field. 651 zone: string, Deprecated. The name of the Google Compute Engine 652[zone](/compute/docs/zones#available) in which the cluster 653resides. 654This field has been deprecated and replaced by the parent field. 655 x__xgafv: string, V1 error format. 656 Allowed values 657 1 - v1 error format 658 2 - v2 error format 659 660Returns: 661 An object of the form: 662 663 { # ListNodePoolsResponse is the result of ListNodePoolsRequest. 664 "nodePools": [ # A list of node pools for a cluster. 665 { # NodePool contains the name and configuration for a cluster's node pool. 666 # Node pools are a set of nodes (i.e. VM's), with a common configuration and 667 # specification, under the control of the cluster master. They may have a set 668 # of Kubernetes labels applied to them, which may be used to reference them 669 # during pod scheduling. They may also be resized up or down, to accommodate 670 # the workload. 671 "status": "A String", # [Output only] The status of the nodes in this pool instance. 672 "statusMessage": "A String", # [Output only] Additional information about the current status of this 673 # node pool instance, if available. 674 "name": "A String", # The name of the node pool. 675 "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance 676 # groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) 677 # associated with this node pool. 678 "A String", 679 ], 680 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaler configuration for this NodePool. Autoscaler is enabled 681 # only if a valid configuration is present. 682 # adjust the size of the node pool to the current cluster usage. 683 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 684 # max_node_count. 685 "enabled": True or False, # Is autoscaling enabled for this node pool. 686 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 687 # has to enough quota to scale up the cluster. 688 }, 689 "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run 690 # simultaneously on a node in the node pool. 691 "maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node. 692 }, 693 "version": "A String", # The version of the Kubernetes of this node. 694 "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your 695 # Compute Engine <a href="/compute/docs/resource-quotas">resource quota</a> 696 # is sufficient for this number of instances. You must also have available 697 # firewall and routes quota. 698 "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. 699 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for this NodePool. 700 # node pool. 701 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 702 # pool. If enabled, the nodes in this node pool will be monitored and, if 703 # they fail health checks too many times, an automatic repair action will be 704 # triggered. 705 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 706 # the Auto Upgrades will proceed. 707 "description": "A String", # [Output only] This field is set when upgrades are about to commence 708 # with the description of the upgrade. 709 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 710 # with the approximate start time for the upgrades, in 711 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 712 }, 713 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 714 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 715 # up to date with the latest release version of Kubernetes. 716 }, 717 "config": { # Parameters that describe the nodes in a cluster. # The node configuration of the pool. 718 "taints": [ # List of kubernetes taints to be applied to each node. 719 # 720 # For more information, including usage and the valid values, see: 721 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 722 { # Kubernetes taint is comprised of three fields: key, value, and effect. Effect 723 # can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. 724 # 725 # For more information, including usage and the valid values, see: 726 # https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ 727 "key": "A String", # Key for taint. 728 "effect": "A String", # Effect for taint. 729 "value": "A String", # Value for taint. 730 }, 731 ], 732 "machineType": "A String", # The name of a Google Compute Engine [machine 733 # type](/compute/docs/machine-types) (e.g. 734 # `n1-standard-1`). 735 # 736 # If unspecified, the default machine type is 737 # `n1-standard-1`. 738 "tags": [ # The list of instance tags applied to all nodes. Tags are used to identify 739 # valid sources or targets for network firewalls and are specified by 740 # the client during cluster or node pool creation. Each tag within the list 741 # must comply with RFC1035. 742 "A String", 743 ], 744 "preemptible": True or False, # Whether the nodes are created as preemptible VM instances. See: 745 # https://cloud.google.com/compute/docs/instances/preemptible for more 746 # information about preemptible VM instances. 747 "labels": { # The map of Kubernetes labels (key/value pairs) to be applied to each node. 748 # These will added in addition to any default label(s) that 749 # Kubernetes may apply to the node. 750 # In case of conflict in label keys, the applied set may differ depending on 751 # the Kubernetes version -- it's best to assume the behavior is undefined 752 # and conflicts should be avoided. 753 # For more information, including usage and the valid values, see: 754 # https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ 755 "a_key": "A String", 756 }, 757 "serviceAccount": "A String", # The Google Cloud Platform Service Account to be used by the node VMs. If 758 # no Service Account is specified, the "default" service account is used. 759 "oauthScopes": [ # The set of Google API scopes to be made available on all of the 760 # node VMs under the "default" service account. 761 # 762 # The following scopes are recommended, but not required, and by default are 763 # not included: 764 # 765 # * `https://www.googleapis.com/auth/compute` is required for mounting 766 # persistent storage on your nodes. 767 # * `https://www.googleapis.com/auth/devstorage.read_only` is required for 768 # communicating with **gcr.io** 769 # (the [Google Container Registry](/container-registry/)). 770 # 771 # If unspecified, no scopes are added, unless Cloud Logging or Cloud 772 # Monitoring are enabled, in which case their required scopes will be added. 773 "A String", 774 ], 775 "diskType": "A String", # Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') 776 # 777 # If unspecified, the default disk type is 'pd-standard' 778 "diskSizeGb": 42, # Size of the disk attached to each node, specified in GB. 779 # The smallest allowed disk size is 10GB. 780 # 781 # If unspecified, the default disk size is 100GB. 782 "accelerators": [ # A list of hardware accelerators to be attached to each node. 783 # See https://cloud.google.com/compute/docs/gpus for more information about 784 # support for GPUs. 785 { # AcceleratorConfig represents a Hardware Accelerator request. 786 "acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance. 787 "acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators 788 # [here](/compute/docs/gpus/#Introduction) 789 }, 790 ], 791 "minCpuPlatform": "A String", # Minimum CPU platform to be used by this instance. The instance may be 792 # scheduled on the specified or newer CPU platform. Applicable values are the 793 # friendly names of CPU platforms, such as 794 # <code>minCpuPlatform: "Intel Haswell"</code> or 795 # <code>minCpuPlatform: "Intel Sandy Bridge"</code>. For more 796 # information, read [how to specify min CPU 797 # platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) 798 "metadata": { # The metadata key/value pairs assigned to instances in the cluster. 799 # 800 # Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes 801 # in length. These are reflected as part of a URL in the metadata server. 802 # Additionally, to avoid ambiguity, keys must not conflict with any other 803 # metadata keys for the project or be one of the reserved keys: 804 # "cluster-location" 805 # "cluster-name" 806 # "cluster-uid" 807 # "configure-sh" 808 # "containerd-configure-sh" 809 # "enable-os-login" 810 # "gci-update-strategy" 811 # "gci-ensure-gke-docker" 812 # "instance-template" 813 # "kube-env" 814 # "startup-script" 815 # "user-data" 816 # "disable-address-manager" 817 # "windows-startup-script-ps1" 818 # "common-psm1" 819 # "k8s-node-setup-psm1" 820 # "install-ssh-psm1" 821 # "user-profile-psm1" 822 # "serial-port-logging-enable" 823 # 824 # Values are free-form strings, and only have meaning as interpreted by 825 # the image running in the instance. The only restriction placed on them is 826 # that each value's size must be less than or equal to 32 KB. 827 # 828 # The total size of all keys and values must be less than 512 KB. 829 "a_key": "A String", 830 }, 831 "imageType": "A String", # The image type to use for this node. Note that for a given image type, 832 # the latest version of it will be used. 833 "localSsdCount": 42, # The number of local SSD disks to be attached to the node. 834 # 835 # The limit for this value is dependant upon the maximum number of 836 # disks available on a machine per zone. See: 837 # https://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits 838 # for more information. 839 }, 840 "conditions": [ # Which conditions caused the current node pool state. 841 { # StatusCondition describes why a cluster or a node pool has a certain status 842 # (e.g., ERROR or DEGRADED). 843 "message": "A String", # Human-friendly representation of the condition 844 "code": "A String", # Machine-friendly representation of the condition 845 }, 846 ], 847 "selfLink": "A String", # [Output only] Server-defined URL for the resource. 848 }, 849 ], 850 }</pre> 851</div> 852 853<div class="method"> 854 <code class="details" id="rollback">rollback(name, body, x__xgafv=None)</code> 855 <pre>Rolls back a previously Aborted or Failed NodePool upgrade. 856This makes no changes if the last upgrade successfully completed. 857 858Args: 859 name: string, The name (project, location, cluster, node pool id) of the node poll to 860rollback upgrade. 861Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. (required) 862 body: object, The request body. (required) 863 The object takes the form of: 864 865{ # RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed 866 # NodePool upgrade. This will be an no-op if the last upgrade successfully 867 # completed. 868 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 869 # number](https://support.google.com/cloud/answer/6158840). 870 # This field has been deprecated and replaced by the name field. 871 "clusterId": "A String", # Deprecated. The name of the cluster to rollback. 872 # This field has been deprecated and replaced by the name field. 873 "name": "A String", # The name (project, location, cluster, node pool id) of the node poll to 874 # rollback upgrade. 875 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. 876 "zone": "A String", # Deprecated. The name of the Google Compute Engine 877 # [zone](/compute/docs/zones#available) in which the cluster 878 # resides. 879 # This field has been deprecated and replaced by the name field. 880 "nodePoolId": "A String", # Deprecated. The name of the node pool to rollback. 881 # This field has been deprecated and replaced by the name field. 882 } 883 884 x__xgafv: string, V1 error format. 885 Allowed values 886 1 - v1 error format 887 2 - v2 error format 888 889Returns: 890 An object of the form: 891 892 { # This operation resource represents operations that may have happened or are 893 # happening on the cluster. All fields are output only. 894 "status": "A String", # The current status of the operation. 895 "selfLink": "A String", # Server-defined URL for the resource. 896 "name": "A String", # The server-assigned ID for the operation. 897 "zone": "A String", # The name of the Google Compute Engine 898 # [zone](/compute/docs/zones#available) in which the operation 899 # is taking place. 900 # This field is deprecated, use location instead. 901 "startTime": "A String", # [Output only] The time the operation started, in 902 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 903 "detail": "A String", # Detailed operation progress, if available. 904 "operationType": "A String", # The operation type. 905 "targetLink": "A String", # Server-defined URL for the target of the operation. 906 "location": "A String", # [Output only] The name of the Google Compute Engine 907 # [zone](/compute/docs/regions-zones/regions-zones#available) or 908 # [region](/compute/docs/regions-zones/regions-zones#available) in which 909 # the cluster resides. 910 "nodepoolConditions": [ # Which conditions caused the current node pool state. 911 { # StatusCondition describes why a cluster or a node pool has a certain status 912 # (e.g., ERROR or DEGRADED). 913 "message": "A String", # Human-friendly representation of the condition 914 "code": "A String", # Machine-friendly representation of the condition 915 }, 916 ], 917 "endTime": "A String", # [Output only] The time the operation completed, in 918 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 919 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 920 "clusterConditions": [ # Which conditions caused the current cluster state. 921 { # StatusCondition describes why a cluster or a node pool has a certain status 922 # (e.g., ERROR or DEGRADED). 923 "message": "A String", # Human-friendly representation of the condition 924 "code": "A String", # Machine-friendly representation of the condition 925 }, 926 ], 927 }</pre> 928</div> 929 930<div class="method"> 931 <code class="details" id="setAutoscaling">setAutoscaling(name, body, x__xgafv=None)</code> 932 <pre>Sets the autoscaling settings for the specified node pool. 933 934Args: 935 name: string, The name (project, location, cluster, node pool) of the node pool to set 936autoscaler settings. Specified in the format 937'projects/*/locations/*/clusters/*/nodePools/*'. (required) 938 body: object, The request body. (required) 939 The object takes the form of: 940 941{ # SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool. 942 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to set 943 # autoscaler settings. Specified in the format 944 # 'projects/*/locations/*/clusters/*/nodePools/*'. 945 "zone": "A String", # Deprecated. The name of the Google Compute Engine 946 # [zone](/compute/docs/zones#available) in which the cluster 947 # resides. 948 # This field has been deprecated and replaced by the name field. 949 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 950 # number](https://support.google.com/cloud/answer/6158840). 951 # This field has been deprecated and replaced by the name field. 952 "autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to # Autoscaling configuration for the node pool. 953 # adjust the size of the node pool to the current cluster usage. 954 "minNodeCount": 42, # Minimum number of nodes in the NodePool. Must be >= 1 and <= 955 # max_node_count. 956 "enabled": True or False, # Is autoscaling enabled for this node pool. 957 "maxNodeCount": 42, # Maximum number of nodes in the NodePool. Must be >= min_node_count. There 958 # has to enough quota to scale up the cluster. 959 }, 960 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. 961 # This field has been deprecated and replaced by the name field. 962 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. 963 # This field has been deprecated and replaced by the name field. 964 } 965 966 x__xgafv: string, V1 error format. 967 Allowed values 968 1 - v1 error format 969 2 - v2 error format 970 971Returns: 972 An object of the form: 973 974 { # This operation resource represents operations that may have happened or are 975 # happening on the cluster. All fields are output only. 976 "status": "A String", # The current status of the operation. 977 "selfLink": "A String", # Server-defined URL for the resource. 978 "name": "A String", # The server-assigned ID for the operation. 979 "zone": "A String", # The name of the Google Compute Engine 980 # [zone](/compute/docs/zones#available) in which the operation 981 # is taking place. 982 # This field is deprecated, use location instead. 983 "startTime": "A String", # [Output only] The time the operation started, in 984 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 985 "detail": "A String", # Detailed operation progress, if available. 986 "operationType": "A String", # The operation type. 987 "targetLink": "A String", # Server-defined URL for the target of the operation. 988 "location": "A String", # [Output only] The name of the Google Compute Engine 989 # [zone](/compute/docs/regions-zones/regions-zones#available) or 990 # [region](/compute/docs/regions-zones/regions-zones#available) in which 991 # the cluster resides. 992 "nodepoolConditions": [ # Which conditions caused the current node pool state. 993 { # StatusCondition describes why a cluster or a node pool has a certain status 994 # (e.g., ERROR or DEGRADED). 995 "message": "A String", # Human-friendly representation of the condition 996 "code": "A String", # Machine-friendly representation of the condition 997 }, 998 ], 999 "endTime": "A String", # [Output only] The time the operation completed, in 1000 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1001 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1002 "clusterConditions": [ # Which conditions caused the current cluster state. 1003 { # StatusCondition describes why a cluster or a node pool has a certain status 1004 # (e.g., ERROR or DEGRADED). 1005 "message": "A String", # Human-friendly representation of the condition 1006 "code": "A String", # Machine-friendly representation of the condition 1007 }, 1008 ], 1009 }</pre> 1010</div> 1011 1012<div class="method"> 1013 <code class="details" id="setManagement">setManagement(name, body, x__xgafv=None)</code> 1014 <pre>Sets the NodeManagement options for a node pool. 1015 1016Args: 1017 name: string, The name (project, location, cluster, node pool id) of the node pool to set 1018management properties. Specified in the format 1019'projects/*/locations/*/clusters/*/nodePools/*'. (required) 1020 body: object, The request body. (required) 1021 The object takes the form of: 1022 1023{ # SetNodePoolManagementRequest sets the node management properties of a node 1024 # pool. 1025 "management": { # NodeManagement defines the set of node management services turned on for the # NodeManagement configuration for the node pool. 1026 # node pool. 1027 "autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node 1028 # pool. If enabled, the nodes in this node pool will be monitored and, if 1029 # they fail health checks too many times, an automatic repair action will be 1030 # triggered. 1031 "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how # Specifies the Auto Upgrade knobs for the node pool. 1032 # the Auto Upgrades will proceed. 1033 "description": "A String", # [Output only] This field is set when upgrades are about to commence 1034 # with the description of the upgrade. 1035 "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence 1036 # with the approximate start time for the upgrades, in 1037 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1038 }, 1039 "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node 1040 # pool. If enabled, node auto-upgrade helps keep the nodes in your node pool 1041 # up to date with the latest release version of Kubernetes. 1042 }, 1043 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set 1044 # management properties. Specified in the format 1045 # 'projects/*/locations/*/clusters/*/nodePools/*'. 1046 "zone": "A String", # Deprecated. The name of the Google Compute Engine 1047 # [zone](/compute/docs/zones#available) in which the cluster 1048 # resides. 1049 # This field has been deprecated and replaced by the name field. 1050 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 1051 # number](https://support.google.com/cloud/answer/6158840). 1052 # This field has been deprecated and replaced by the name field. 1053 "clusterId": "A String", # Deprecated. The name of the cluster to update. 1054 # This field has been deprecated and replaced by the name field. 1055 "nodePoolId": "A String", # Deprecated. The name of the node pool to update. 1056 # This field has been deprecated and replaced by the name field. 1057 } 1058 1059 x__xgafv: string, V1 error format. 1060 Allowed values 1061 1 - v1 error format 1062 2 - v2 error format 1063 1064Returns: 1065 An object of the form: 1066 1067 { # This operation resource represents operations that may have happened or are 1068 # happening on the cluster. All fields are output only. 1069 "status": "A String", # The current status of the operation. 1070 "selfLink": "A String", # Server-defined URL for the resource. 1071 "name": "A String", # The server-assigned ID for the operation. 1072 "zone": "A String", # The name of the Google Compute Engine 1073 # [zone](/compute/docs/zones#available) in which the operation 1074 # is taking place. 1075 # This field is deprecated, use location instead. 1076 "startTime": "A String", # [Output only] The time the operation started, in 1077 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1078 "detail": "A String", # Detailed operation progress, if available. 1079 "operationType": "A String", # The operation type. 1080 "targetLink": "A String", # Server-defined URL for the target of the operation. 1081 "location": "A String", # [Output only] The name of the Google Compute Engine 1082 # [zone](/compute/docs/regions-zones/regions-zones#available) or 1083 # [region](/compute/docs/regions-zones/regions-zones#available) in which 1084 # the cluster resides. 1085 "nodepoolConditions": [ # Which conditions caused the current node pool state. 1086 { # StatusCondition describes why a cluster or a node pool has a certain status 1087 # (e.g., ERROR or DEGRADED). 1088 "message": "A String", # Human-friendly representation of the condition 1089 "code": "A String", # Machine-friendly representation of the condition 1090 }, 1091 ], 1092 "endTime": "A String", # [Output only] The time the operation completed, in 1093 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1094 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1095 "clusterConditions": [ # Which conditions caused the current cluster state. 1096 { # StatusCondition describes why a cluster or a node pool has a certain status 1097 # (e.g., ERROR or DEGRADED). 1098 "message": "A String", # Human-friendly representation of the condition 1099 "code": "A String", # Machine-friendly representation of the condition 1100 }, 1101 ], 1102 }</pre> 1103</div> 1104 1105<div class="method"> 1106 <code class="details" id="setSize">setSize(name, body, x__xgafv=None)</code> 1107 <pre>Sets the size for a specific node pool. 1108 1109Args: 1110 name: string, The name (project, location, cluster, node pool id) of the node pool to set 1111size. 1112Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. (required) 1113 body: object, The request body. (required) 1114 The object takes the form of: 1115 1116{ # SetNodePoolSizeRequest sets the size a node 1117 # pool. 1118 "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set 1119 # size. 1120 # Specified in the format 'projects/*/locations/*/clusters/*/nodePools/*'. 1121 "zone": "A String", # Deprecated. The name of the Google Compute Engine 1122 # [zone](/compute/docs/zones#available) in which the cluster 1123 # resides. 1124 # This field has been deprecated and replaced by the name field. 1125 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 1126 # number](https://support.google.com/cloud/answer/6158840). 1127 # This field has been deprecated and replaced by the name field. 1128 "clusterId": "A String", # Deprecated. The name of the cluster to update. 1129 # This field has been deprecated and replaced by the name field. 1130 "nodePoolId": "A String", # Deprecated. The name of the node pool to update. 1131 # This field has been deprecated and replaced by the name field. 1132 "nodeCount": 42, # The desired node count for the pool. 1133 } 1134 1135 x__xgafv: string, V1 error format. 1136 Allowed values 1137 1 - v1 error format 1138 2 - v2 error format 1139 1140Returns: 1141 An object of the form: 1142 1143 { # This operation resource represents operations that may have happened or are 1144 # happening on the cluster. All fields are output only. 1145 "status": "A String", # The current status of the operation. 1146 "selfLink": "A String", # Server-defined URL for the resource. 1147 "name": "A String", # The server-assigned ID for the operation. 1148 "zone": "A String", # The name of the Google Compute Engine 1149 # [zone](/compute/docs/zones#available) in which the operation 1150 # is taking place. 1151 # This field is deprecated, use location instead. 1152 "startTime": "A String", # [Output only] The time the operation started, in 1153 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1154 "detail": "A String", # Detailed operation progress, if available. 1155 "operationType": "A String", # The operation type. 1156 "targetLink": "A String", # Server-defined URL for the target of the operation. 1157 "location": "A String", # [Output only] The name of the Google Compute Engine 1158 # [zone](/compute/docs/regions-zones/regions-zones#available) or 1159 # [region](/compute/docs/regions-zones/regions-zones#available) in which 1160 # the cluster resides. 1161 "nodepoolConditions": [ # Which conditions caused the current node pool state. 1162 { # StatusCondition describes why a cluster or a node pool has a certain status 1163 # (e.g., ERROR or DEGRADED). 1164 "message": "A String", # Human-friendly representation of the condition 1165 "code": "A String", # Machine-friendly representation of the condition 1166 }, 1167 ], 1168 "endTime": "A String", # [Output only] The time the operation completed, in 1169 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1170 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1171 "clusterConditions": [ # Which conditions caused the current cluster state. 1172 { # StatusCondition describes why a cluster or a node pool has a certain status 1173 # (e.g., ERROR or DEGRADED). 1174 "message": "A String", # Human-friendly representation of the condition 1175 "code": "A String", # Machine-friendly representation of the condition 1176 }, 1177 ], 1178 }</pre> 1179</div> 1180 1181<div class="method"> 1182 <code class="details" id="update">update(name, body, x__xgafv=None)</code> 1183 <pre>Updates the version and/or image type for the specified node pool. 1184 1185Args: 1186 name: string, The name (project, location, cluster, node pool) of the node pool to 1187update. Specified in the format 1188'projects/*/locations/*/clusters/*/nodePools/*'. (required) 1189 body: object, The request body. (required) 1190 The object takes the form of: 1191 1192{ # UpdateNodePoolRequests update a node pool's image and/or version. 1193 "name": "A String", # The name (project, location, cluster, node pool) of the node pool to 1194 # update. Specified in the format 1195 # 'projects/*/locations/*/clusters/*/nodePools/*'. 1196 "zone": "A String", # Deprecated. The name of the Google Compute Engine 1197 # [zone](/compute/docs/zones#available) in which the cluster 1198 # resides. 1199 # This field has been deprecated and replaced by the name field. 1200 "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project 1201 # number](https://support.google.com/cloud/answer/6158840). 1202 # This field has been deprecated and replaced by the name field. 1203 "clusterId": "A String", # Deprecated. The name of the cluster to upgrade. 1204 # This field has been deprecated and replaced by the name field. 1205 "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. 1206 # This field has been deprecated and replaced by the name field. 1207 "nodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an 1208 # upgrade). 1209 # 1210 # Users may specify either explicit versions offered by Kubernetes Engine or 1211 # version aliases, which have the following behavior: 1212 # 1213 # - "latest": picks the highest valid Kubernetes version 1214 # - "1.X": picks the highest valid patch+gke.N patch in the 1.X version 1215 # - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version 1216 # - "1.X.Y-gke.N": picks an explicit Kubernetes version 1217 # - "-": picks the Kubernetes master version 1218 "imageType": "A String", # The desired image type for the node pool. 1219 } 1220 1221 x__xgafv: string, V1 error format. 1222 Allowed values 1223 1 - v1 error format 1224 2 - v2 error format 1225 1226Returns: 1227 An object of the form: 1228 1229 { # This operation resource represents operations that may have happened or are 1230 # happening on the cluster. All fields are output only. 1231 "status": "A String", # The current status of the operation. 1232 "selfLink": "A String", # Server-defined URL for the resource. 1233 "name": "A String", # The server-assigned ID for the operation. 1234 "zone": "A String", # The name of the Google Compute Engine 1235 # [zone](/compute/docs/zones#available) in which the operation 1236 # is taking place. 1237 # This field is deprecated, use location instead. 1238 "startTime": "A String", # [Output only] The time the operation started, in 1239 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1240 "detail": "A String", # Detailed operation progress, if available. 1241 "operationType": "A String", # The operation type. 1242 "targetLink": "A String", # Server-defined URL for the target of the operation. 1243 "location": "A String", # [Output only] The name of the Google Compute Engine 1244 # [zone](/compute/docs/regions-zones/regions-zones#available) or 1245 # [region](/compute/docs/regions-zones/regions-zones#available) in which 1246 # the cluster resides. 1247 "nodepoolConditions": [ # Which conditions caused the current node pool state. 1248 { # StatusCondition describes why a cluster or a node pool has a certain status 1249 # (e.g., ERROR or DEGRADED). 1250 "message": "A String", # Human-friendly representation of the condition 1251 "code": "A String", # Machine-friendly representation of the condition 1252 }, 1253 ], 1254 "endTime": "A String", # [Output only] The time the operation completed, in 1255 # [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. 1256 "statusMessage": "A String", # If an error has occurred, a textual description of the error. 1257 "clusterConditions": [ # Which conditions caused the current cluster state. 1258 { # StatusCondition describes why a cluster or a node pool has a certain status 1259 # (e.g., ERROR or DEGRADED). 1260 "message": "A String", # Human-friendly representation of the condition 1261 "code": "A String", # Machine-friendly representation of the condition 1262 }, 1263 ], 1264 }</pre> 1265</div> 1266 1267</body></html>