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