1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/container/v1/cluster_service.proto 18 19 package com.google.container.v1; 20 21 public interface NodePoolOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.container.v1.NodePool) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The name of the node pool. 31 * </pre> 32 * 33 * <code>string name = 1;</code> 34 * 35 * @return The name. 36 */ getName()37 java.lang.String getName(); 38 /** 39 * 40 * 41 * <pre> 42 * The name of the node pool. 43 * </pre> 44 * 45 * <code>string name = 1;</code> 46 * 47 * @return The bytes for name. 48 */ getNameBytes()49 com.google.protobuf.ByteString getNameBytes(); 50 51 /** 52 * 53 * 54 * <pre> 55 * The node configuration of the pool. 56 * </pre> 57 * 58 * <code>.google.container.v1.NodeConfig config = 2;</code> 59 * 60 * @return Whether the config field is set. 61 */ hasConfig()62 boolean hasConfig(); 63 /** 64 * 65 * 66 * <pre> 67 * The node configuration of the pool. 68 * </pre> 69 * 70 * <code>.google.container.v1.NodeConfig config = 2;</code> 71 * 72 * @return The config. 73 */ getConfig()74 com.google.container.v1.NodeConfig getConfig(); 75 /** 76 * 77 * 78 * <pre> 79 * The node configuration of the pool. 80 * </pre> 81 * 82 * <code>.google.container.v1.NodeConfig config = 2;</code> 83 */ getConfigOrBuilder()84 com.google.container.v1.NodeConfigOrBuilder getConfigOrBuilder(); 85 86 /** 87 * 88 * 89 * <pre> 90 * The initial node count for the pool. You must ensure that your 91 * Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 92 * is sufficient for this number of instances. You must also have available 93 * firewall and routes quota. 94 * </pre> 95 * 96 * <code>int32 initial_node_count = 3;</code> 97 * 98 * @return The initialNodeCount. 99 */ getInitialNodeCount()100 int getInitialNodeCount(); 101 102 /** 103 * 104 * 105 * <pre> 106 * The list of Google Compute Engine 107 * [zones](https://cloud.google.com/compute/docs/zones#available) in which the 108 * NodePool's nodes should be located. 109 * If this value is unspecified during node pool creation, the 110 * [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) 111 * value will be used, instead. 112 * Warning: changing node pool locations will result in nodes being added 113 * and/or removed. 114 * </pre> 115 * 116 * <code>repeated string locations = 13;</code> 117 * 118 * @return A list containing the locations. 119 */ getLocationsList()120 java.util.List<java.lang.String> getLocationsList(); 121 /** 122 * 123 * 124 * <pre> 125 * The list of Google Compute Engine 126 * [zones](https://cloud.google.com/compute/docs/zones#available) in which the 127 * NodePool's nodes should be located. 128 * If this value is unspecified during node pool creation, the 129 * [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) 130 * value will be used, instead. 131 * Warning: changing node pool locations will result in nodes being added 132 * and/or removed. 133 * </pre> 134 * 135 * <code>repeated string locations = 13;</code> 136 * 137 * @return The count of locations. 138 */ getLocationsCount()139 int getLocationsCount(); 140 /** 141 * 142 * 143 * <pre> 144 * The list of Google Compute Engine 145 * [zones](https://cloud.google.com/compute/docs/zones#available) in which the 146 * NodePool's nodes should be located. 147 * If this value is unspecified during node pool creation, the 148 * [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) 149 * value will be used, instead. 150 * Warning: changing node pool locations will result in nodes being added 151 * and/or removed. 152 * </pre> 153 * 154 * <code>repeated string locations = 13;</code> 155 * 156 * @param index The index of the element to return. 157 * @return The locations at the given index. 158 */ getLocations(int index)159 java.lang.String getLocations(int index); 160 /** 161 * 162 * 163 * <pre> 164 * The list of Google Compute Engine 165 * [zones](https://cloud.google.com/compute/docs/zones#available) in which the 166 * NodePool's nodes should be located. 167 * If this value is unspecified during node pool creation, the 168 * [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) 169 * value will be used, instead. 170 * Warning: changing node pool locations will result in nodes being added 171 * and/or removed. 172 * </pre> 173 * 174 * <code>repeated string locations = 13;</code> 175 * 176 * @param index The index of the value to return. 177 * @return The bytes of the locations at the given index. 178 */ getLocationsBytes(int index)179 com.google.protobuf.ByteString getLocationsBytes(int index); 180 181 /** 182 * 183 * 184 * <pre> 185 * Networking configuration for this NodePool. If specified, it overrides the 186 * cluster-level defaults. 187 * </pre> 188 * 189 * <code>.google.container.v1.NodeNetworkConfig network_config = 14;</code> 190 * 191 * @return Whether the networkConfig field is set. 192 */ hasNetworkConfig()193 boolean hasNetworkConfig(); 194 /** 195 * 196 * 197 * <pre> 198 * Networking configuration for this NodePool. If specified, it overrides the 199 * cluster-level defaults. 200 * </pre> 201 * 202 * <code>.google.container.v1.NodeNetworkConfig network_config = 14;</code> 203 * 204 * @return The networkConfig. 205 */ getNetworkConfig()206 com.google.container.v1.NodeNetworkConfig getNetworkConfig(); 207 /** 208 * 209 * 210 * <pre> 211 * Networking configuration for this NodePool. If specified, it overrides the 212 * cluster-level defaults. 213 * </pre> 214 * 215 * <code>.google.container.v1.NodeNetworkConfig network_config = 14;</code> 216 */ getNetworkConfigOrBuilder()217 com.google.container.v1.NodeNetworkConfigOrBuilder getNetworkConfigOrBuilder(); 218 219 /** 220 * 221 * 222 * <pre> 223 * [Output only] Server-defined URL for the resource. 224 * </pre> 225 * 226 * <code>string self_link = 100;</code> 227 * 228 * @return The selfLink. 229 */ getSelfLink()230 java.lang.String getSelfLink(); 231 /** 232 * 233 * 234 * <pre> 235 * [Output only] Server-defined URL for the resource. 236 * </pre> 237 * 238 * <code>string self_link = 100;</code> 239 * 240 * @return The bytes for selfLink. 241 */ getSelfLinkBytes()242 com.google.protobuf.ByteString getSelfLinkBytes(); 243 244 /** 245 * 246 * 247 * <pre> 248 * The version of Kubernetes running on this NodePool's nodes. If unspecified, 249 * it defaults as described 250 * [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). 251 * </pre> 252 * 253 * <code>string version = 101;</code> 254 * 255 * @return The version. 256 */ getVersion()257 java.lang.String getVersion(); 258 /** 259 * 260 * 261 * <pre> 262 * The version of Kubernetes running on this NodePool's nodes. If unspecified, 263 * it defaults as described 264 * [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). 265 * </pre> 266 * 267 * <code>string version = 101;</code> 268 * 269 * @return The bytes for version. 270 */ getVersionBytes()271 com.google.protobuf.ByteString getVersionBytes(); 272 273 /** 274 * 275 * 276 * <pre> 277 * [Output only] The resource URLs of the [managed instance 278 * groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) 279 * associated with this node pool. 280 * During the node pool blue-green upgrade operation, the URLs contain both 281 * blue and green resources. 282 * </pre> 283 * 284 * <code>repeated string instance_group_urls = 102;</code> 285 * 286 * @return A list containing the instanceGroupUrls. 287 */ getInstanceGroupUrlsList()288 java.util.List<java.lang.String> getInstanceGroupUrlsList(); 289 /** 290 * 291 * 292 * <pre> 293 * [Output only] The resource URLs of the [managed instance 294 * groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) 295 * associated with this node pool. 296 * During the node pool blue-green upgrade operation, the URLs contain both 297 * blue and green resources. 298 * </pre> 299 * 300 * <code>repeated string instance_group_urls = 102;</code> 301 * 302 * @return The count of instanceGroupUrls. 303 */ getInstanceGroupUrlsCount()304 int getInstanceGroupUrlsCount(); 305 /** 306 * 307 * 308 * <pre> 309 * [Output only] The resource URLs of the [managed instance 310 * groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) 311 * associated with this node pool. 312 * During the node pool blue-green upgrade operation, the URLs contain both 313 * blue and green resources. 314 * </pre> 315 * 316 * <code>repeated string instance_group_urls = 102;</code> 317 * 318 * @param index The index of the element to return. 319 * @return The instanceGroupUrls at the given index. 320 */ getInstanceGroupUrls(int index)321 java.lang.String getInstanceGroupUrls(int index); 322 /** 323 * 324 * 325 * <pre> 326 * [Output only] The resource URLs of the [managed instance 327 * groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) 328 * associated with this node pool. 329 * During the node pool blue-green upgrade operation, the URLs contain both 330 * blue and green resources. 331 * </pre> 332 * 333 * <code>repeated string instance_group_urls = 102;</code> 334 * 335 * @param index The index of the value to return. 336 * @return The bytes of the instanceGroupUrls at the given index. 337 */ getInstanceGroupUrlsBytes(int index)338 com.google.protobuf.ByteString getInstanceGroupUrlsBytes(int index); 339 340 /** 341 * 342 * 343 * <pre> 344 * [Output only] The status of the nodes in this pool instance. 345 * </pre> 346 * 347 * <code>.google.container.v1.NodePool.Status status = 103;</code> 348 * 349 * @return The enum numeric value on the wire for status. 350 */ getStatusValue()351 int getStatusValue(); 352 /** 353 * 354 * 355 * <pre> 356 * [Output only] The status of the nodes in this pool instance. 357 * </pre> 358 * 359 * <code>.google.container.v1.NodePool.Status status = 103;</code> 360 * 361 * @return The status. 362 */ getStatus()363 com.google.container.v1.NodePool.Status getStatus(); 364 365 /** 366 * 367 * 368 * <pre> 369 * [Output only] Deprecated. Use conditions instead. 370 * Additional information about the current status of this 371 * node pool instance, if available. 372 * </pre> 373 * 374 * <code>string status_message = 104 [deprecated = true];</code> 375 * 376 * @deprecated google.container.v1.NodePool.status_message is deprecated. See 377 * google/container/v1/cluster_service.proto;l=3292 378 * @return The statusMessage. 379 */ 380 @java.lang.Deprecated getStatusMessage()381 java.lang.String getStatusMessage(); 382 /** 383 * 384 * 385 * <pre> 386 * [Output only] Deprecated. Use conditions instead. 387 * Additional information about the current status of this 388 * node pool instance, if available. 389 * </pre> 390 * 391 * <code>string status_message = 104 [deprecated = true];</code> 392 * 393 * @deprecated google.container.v1.NodePool.status_message is deprecated. See 394 * google/container/v1/cluster_service.proto;l=3292 395 * @return The bytes for statusMessage. 396 */ 397 @java.lang.Deprecated getStatusMessageBytes()398 com.google.protobuf.ByteString getStatusMessageBytes(); 399 400 /** 401 * 402 * 403 * <pre> 404 * Autoscaler configuration for this NodePool. Autoscaler is enabled 405 * only if a valid configuration is present. 406 * </pre> 407 * 408 * <code>.google.container.v1.NodePoolAutoscaling autoscaling = 4;</code> 409 * 410 * @return Whether the autoscaling field is set. 411 */ hasAutoscaling()412 boolean hasAutoscaling(); 413 /** 414 * 415 * 416 * <pre> 417 * Autoscaler configuration for this NodePool. Autoscaler is enabled 418 * only if a valid configuration is present. 419 * </pre> 420 * 421 * <code>.google.container.v1.NodePoolAutoscaling autoscaling = 4;</code> 422 * 423 * @return The autoscaling. 424 */ getAutoscaling()425 com.google.container.v1.NodePoolAutoscaling getAutoscaling(); 426 /** 427 * 428 * 429 * <pre> 430 * Autoscaler configuration for this NodePool. Autoscaler is enabled 431 * only if a valid configuration is present. 432 * </pre> 433 * 434 * <code>.google.container.v1.NodePoolAutoscaling autoscaling = 4;</code> 435 */ getAutoscalingOrBuilder()436 com.google.container.v1.NodePoolAutoscalingOrBuilder getAutoscalingOrBuilder(); 437 438 /** 439 * 440 * 441 * <pre> 442 * NodeManagement configuration for this NodePool. 443 * </pre> 444 * 445 * <code>.google.container.v1.NodeManagement management = 5;</code> 446 * 447 * @return Whether the management field is set. 448 */ hasManagement()449 boolean hasManagement(); 450 /** 451 * 452 * 453 * <pre> 454 * NodeManagement configuration for this NodePool. 455 * </pre> 456 * 457 * <code>.google.container.v1.NodeManagement management = 5;</code> 458 * 459 * @return The management. 460 */ getManagement()461 com.google.container.v1.NodeManagement getManagement(); 462 /** 463 * 464 * 465 * <pre> 466 * NodeManagement configuration for this NodePool. 467 * </pre> 468 * 469 * <code>.google.container.v1.NodeManagement management = 5;</code> 470 */ getManagementOrBuilder()471 com.google.container.v1.NodeManagementOrBuilder getManagementOrBuilder(); 472 473 /** 474 * 475 * 476 * <pre> 477 * The constraint on the maximum number of pods that can be run 478 * simultaneously on a node in the node pool. 479 * </pre> 480 * 481 * <code>.google.container.v1.MaxPodsConstraint max_pods_constraint = 6;</code> 482 * 483 * @return Whether the maxPodsConstraint field is set. 484 */ hasMaxPodsConstraint()485 boolean hasMaxPodsConstraint(); 486 /** 487 * 488 * 489 * <pre> 490 * The constraint on the maximum number of pods that can be run 491 * simultaneously on a node in the node pool. 492 * </pre> 493 * 494 * <code>.google.container.v1.MaxPodsConstraint max_pods_constraint = 6;</code> 495 * 496 * @return The maxPodsConstraint. 497 */ getMaxPodsConstraint()498 com.google.container.v1.MaxPodsConstraint getMaxPodsConstraint(); 499 /** 500 * 501 * 502 * <pre> 503 * The constraint on the maximum number of pods that can be run 504 * simultaneously on a node in the node pool. 505 * </pre> 506 * 507 * <code>.google.container.v1.MaxPodsConstraint max_pods_constraint = 6;</code> 508 */ getMaxPodsConstraintOrBuilder()509 com.google.container.v1.MaxPodsConstraintOrBuilder getMaxPodsConstraintOrBuilder(); 510 511 /** 512 * 513 * 514 * <pre> 515 * Which conditions caused the current node pool state. 516 * </pre> 517 * 518 * <code>repeated .google.container.v1.StatusCondition conditions = 105;</code> 519 */ getConditionsList()520 java.util.List<com.google.container.v1.StatusCondition> getConditionsList(); 521 /** 522 * 523 * 524 * <pre> 525 * Which conditions caused the current node pool state. 526 * </pre> 527 * 528 * <code>repeated .google.container.v1.StatusCondition conditions = 105;</code> 529 */ getConditions(int index)530 com.google.container.v1.StatusCondition getConditions(int index); 531 /** 532 * 533 * 534 * <pre> 535 * Which conditions caused the current node pool state. 536 * </pre> 537 * 538 * <code>repeated .google.container.v1.StatusCondition conditions = 105;</code> 539 */ getConditionsCount()540 int getConditionsCount(); 541 /** 542 * 543 * 544 * <pre> 545 * Which conditions caused the current node pool state. 546 * </pre> 547 * 548 * <code>repeated .google.container.v1.StatusCondition conditions = 105;</code> 549 */ 550 java.util.List<? extends com.google.container.v1.StatusConditionOrBuilder> getConditionsOrBuilderList()551 getConditionsOrBuilderList(); 552 /** 553 * 554 * 555 * <pre> 556 * Which conditions caused the current node pool state. 557 * </pre> 558 * 559 * <code>repeated .google.container.v1.StatusCondition conditions = 105;</code> 560 */ getConditionsOrBuilder(int index)561 com.google.container.v1.StatusConditionOrBuilder getConditionsOrBuilder(int index); 562 563 /** 564 * 565 * 566 * <pre> 567 * [Output only] The pod CIDR block size per node in this node pool. 568 * </pre> 569 * 570 * <code>int32 pod_ipv4_cidr_size = 7;</code> 571 * 572 * @return The podIpv4CidrSize. 573 */ getPodIpv4CidrSize()574 int getPodIpv4CidrSize(); 575 576 /** 577 * 578 * 579 * <pre> 580 * Upgrade settings control disruption and speed of the upgrade. 581 * </pre> 582 * 583 * <code>.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 107;</code> 584 * 585 * @return Whether the upgradeSettings field is set. 586 */ hasUpgradeSettings()587 boolean hasUpgradeSettings(); 588 /** 589 * 590 * 591 * <pre> 592 * Upgrade settings control disruption and speed of the upgrade. 593 * </pre> 594 * 595 * <code>.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 107;</code> 596 * 597 * @return The upgradeSettings. 598 */ getUpgradeSettings()599 com.google.container.v1.NodePool.UpgradeSettings getUpgradeSettings(); 600 /** 601 * 602 * 603 * <pre> 604 * Upgrade settings control disruption and speed of the upgrade. 605 * </pre> 606 * 607 * <code>.google.container.v1.NodePool.UpgradeSettings upgrade_settings = 107;</code> 608 */ getUpgradeSettingsOrBuilder()609 com.google.container.v1.NodePool.UpgradeSettingsOrBuilder getUpgradeSettingsOrBuilder(); 610 611 /** 612 * 613 * 614 * <pre> 615 * Specifies the node placement policy. 616 * </pre> 617 * 618 * <code>.google.container.v1.NodePool.PlacementPolicy placement_policy = 108;</code> 619 * 620 * @return Whether the placementPolicy field is set. 621 */ hasPlacementPolicy()622 boolean hasPlacementPolicy(); 623 /** 624 * 625 * 626 * <pre> 627 * Specifies the node placement policy. 628 * </pre> 629 * 630 * <code>.google.container.v1.NodePool.PlacementPolicy placement_policy = 108;</code> 631 * 632 * @return The placementPolicy. 633 */ getPlacementPolicy()634 com.google.container.v1.NodePool.PlacementPolicy getPlacementPolicy(); 635 /** 636 * 637 * 638 * <pre> 639 * Specifies the node placement policy. 640 * </pre> 641 * 642 * <code>.google.container.v1.NodePool.PlacementPolicy placement_policy = 108;</code> 643 */ getPlacementPolicyOrBuilder()644 com.google.container.v1.NodePool.PlacementPolicyOrBuilder getPlacementPolicyOrBuilder(); 645 646 /** 647 * 648 * 649 * <pre> 650 * Output only. [Output only] Update info contains relevant information during 651 * a node pool update. 652 * </pre> 653 * 654 * <code> 655 * .google.container.v1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY]; 656 * </code> 657 * 658 * @return Whether the updateInfo field is set. 659 */ hasUpdateInfo()660 boolean hasUpdateInfo(); 661 /** 662 * 663 * 664 * <pre> 665 * Output only. [Output only] Update info contains relevant information during 666 * a node pool update. 667 * </pre> 668 * 669 * <code> 670 * .google.container.v1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY]; 671 * </code> 672 * 673 * @return The updateInfo. 674 */ getUpdateInfo()675 com.google.container.v1.NodePool.UpdateInfo getUpdateInfo(); 676 /** 677 * 678 * 679 * <pre> 680 * Output only. [Output only] Update info contains relevant information during 681 * a node pool update. 682 * </pre> 683 * 684 * <code> 685 * .google.container.v1.NodePool.UpdateInfo update_info = 109 [(.google.api.field_behavior) = OUTPUT_ONLY]; 686 * </code> 687 */ getUpdateInfoOrBuilder()688 com.google.container.v1.NodePool.UpdateInfoOrBuilder getUpdateInfoOrBuilder(); 689 690 /** 691 * 692 * 693 * <pre> 694 * This checksum is computed by the server based on the value of node pool 695 * fields, and may be sent on update requests to ensure the client has an 696 * up-to-date value before proceeding. 697 * </pre> 698 * 699 * <code>string etag = 110;</code> 700 * 701 * @return The etag. 702 */ getEtag()703 java.lang.String getEtag(); 704 /** 705 * 706 * 707 * <pre> 708 * This checksum is computed by the server based on the value of node pool 709 * fields, and may be sent on update requests to ensure the client has an 710 * up-to-date value before proceeding. 711 * </pre> 712 * 713 * <code>string etag = 110;</code> 714 * 715 * @return The bytes for etag. 716 */ getEtagBytes()717 com.google.protobuf.ByteString getEtagBytes(); 718 } 719