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/cloud/compute/v1/compute.proto 18 19 package com.google.cloud.compute.v1; 20 21 public interface AutoscalerOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.Autoscaler) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 31 * </pre> 32 * 33 * <code>optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041; 34 * </code> 35 * 36 * @return Whether the autoscalingPolicy field is set. 37 */ hasAutoscalingPolicy()38 boolean hasAutoscalingPolicy(); 39 /** 40 * 41 * 42 * <pre> 43 * The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 44 * </pre> 45 * 46 * <code>optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041; 47 * </code> 48 * 49 * @return The autoscalingPolicy. 50 */ getAutoscalingPolicy()51 com.google.cloud.compute.v1.AutoscalingPolicy getAutoscalingPolicy(); 52 /** 53 * 54 * 55 * <pre> 56 * The configuration parameters for the autoscaling algorithm. You can define one or more signals for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization. If none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%. 57 * </pre> 58 * 59 * <code>optional .google.cloud.compute.v1.AutoscalingPolicy autoscaling_policy = 221950041; 60 * </code> 61 */ getAutoscalingPolicyOrBuilder()62 com.google.cloud.compute.v1.AutoscalingPolicyOrBuilder getAutoscalingPolicyOrBuilder(); 63 64 /** 65 * 66 * 67 * <pre> 68 * [Output Only] Creation timestamp in RFC3339 text format. 69 * </pre> 70 * 71 * <code>optional string creation_timestamp = 30525366;</code> 72 * 73 * @return Whether the creationTimestamp field is set. 74 */ hasCreationTimestamp()75 boolean hasCreationTimestamp(); 76 /** 77 * 78 * 79 * <pre> 80 * [Output Only] Creation timestamp in RFC3339 text format. 81 * </pre> 82 * 83 * <code>optional string creation_timestamp = 30525366;</code> 84 * 85 * @return The creationTimestamp. 86 */ getCreationTimestamp()87 java.lang.String getCreationTimestamp(); 88 /** 89 * 90 * 91 * <pre> 92 * [Output Only] Creation timestamp in RFC3339 text format. 93 * </pre> 94 * 95 * <code>optional string creation_timestamp = 30525366;</code> 96 * 97 * @return The bytes for creationTimestamp. 98 */ getCreationTimestampBytes()99 com.google.protobuf.ByteString getCreationTimestampBytes(); 100 101 /** 102 * 103 * 104 * <pre> 105 * An optional description of this resource. Provide this property when you create the resource. 106 * </pre> 107 * 108 * <code>optional string description = 422937596;</code> 109 * 110 * @return Whether the description field is set. 111 */ hasDescription()112 boolean hasDescription(); 113 /** 114 * 115 * 116 * <pre> 117 * An optional description of this resource. Provide this property when you create the resource. 118 * </pre> 119 * 120 * <code>optional string description = 422937596;</code> 121 * 122 * @return The description. 123 */ getDescription()124 java.lang.String getDescription(); 125 /** 126 * 127 * 128 * <pre> 129 * An optional description of this resource. Provide this property when you create the resource. 130 * </pre> 131 * 132 * <code>optional string description = 422937596;</code> 133 * 134 * @return The bytes for description. 135 */ getDescriptionBytes()136 com.google.protobuf.ByteString getDescriptionBytes(); 137 138 /** 139 * 140 * 141 * <pre> 142 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 143 * </pre> 144 * 145 * <code>optional uint64 id = 3355;</code> 146 * 147 * @return Whether the id field is set. 148 */ hasId()149 boolean hasId(); 150 /** 151 * 152 * 153 * <pre> 154 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 155 * </pre> 156 * 157 * <code>optional uint64 id = 3355;</code> 158 * 159 * @return The id. 160 */ getId()161 long getId(); 162 163 /** 164 * 165 * 166 * <pre> 167 * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 168 * </pre> 169 * 170 * <code>optional string kind = 3292052;</code> 171 * 172 * @return Whether the kind field is set. 173 */ hasKind()174 boolean hasKind(); 175 /** 176 * 177 * 178 * <pre> 179 * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 180 * </pre> 181 * 182 * <code>optional string kind = 3292052;</code> 183 * 184 * @return The kind. 185 */ getKind()186 java.lang.String getKind(); 187 /** 188 * 189 * 190 * <pre> 191 * [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. 192 * </pre> 193 * 194 * <code>optional string kind = 3292052;</code> 195 * 196 * @return The bytes for kind. 197 */ getKindBytes()198 com.google.protobuf.ByteString getKindBytes(); 199 200 /** 201 * 202 * 203 * <pre> 204 * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 205 * </pre> 206 * 207 * <code>optional string name = 3373707;</code> 208 * 209 * @return Whether the name field is set. 210 */ hasName()211 boolean hasName(); 212 /** 213 * 214 * 215 * <pre> 216 * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 217 * </pre> 218 * 219 * <code>optional string name = 3373707;</code> 220 * 221 * @return The name. 222 */ getName()223 java.lang.String getName(); 224 /** 225 * 226 * 227 * <pre> 228 * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 229 * </pre> 230 * 231 * <code>optional string name = 3373707;</code> 232 * 233 * @return The bytes for name. 234 */ getNameBytes()235 com.google.protobuf.ByteString getNameBytes(); 236 237 /** 238 * 239 * 240 * <pre> 241 * [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. 242 * </pre> 243 * 244 * <code>optional int32 recommended_size = 257915749;</code> 245 * 246 * @return Whether the recommendedSize field is set. 247 */ hasRecommendedSize()248 boolean hasRecommendedSize(); 249 /** 250 * 251 * 252 * <pre> 253 * [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. 254 * </pre> 255 * 256 * <code>optional int32 recommended_size = 257915749;</code> 257 * 258 * @return The recommendedSize. 259 */ getRecommendedSize()260 int getRecommendedSize(); 261 262 /** 263 * 264 * 265 * <pre> 266 * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 267 * </pre> 268 * 269 * <code>optional string region = 138946292;</code> 270 * 271 * @return Whether the region field is set. 272 */ hasRegion()273 boolean hasRegion(); 274 /** 275 * 276 * 277 * <pre> 278 * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 279 * </pre> 280 * 281 * <code>optional string region = 138946292;</code> 282 * 283 * @return The region. 284 */ getRegion()285 java.lang.String getRegion(); 286 /** 287 * 288 * 289 * <pre> 290 * [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). 291 * </pre> 292 * 293 * <code>optional string region = 138946292;</code> 294 * 295 * @return The bytes for region. 296 */ getRegionBytes()297 com.google.protobuf.ByteString getRegionBytes(); 298 299 /** 300 * 301 * 302 * <pre> 303 * [Output Only] Status information of existing scaling schedules. 304 * </pre> 305 * 306 * <code> 307 * map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178; 308 * </code> 309 */ getScalingScheduleStatusCount()310 int getScalingScheduleStatusCount(); 311 /** 312 * 313 * 314 * <pre> 315 * [Output Only] Status information of existing scaling schedules. 316 * </pre> 317 * 318 * <code> 319 * map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178; 320 * </code> 321 */ containsScalingScheduleStatus(java.lang.String key)322 boolean containsScalingScheduleStatus(java.lang.String key); 323 /** Use {@link #getScalingScheduleStatusMap()} instead. */ 324 @java.lang.Deprecated 325 java.util.Map<java.lang.String, com.google.cloud.compute.v1.ScalingScheduleStatus> getScalingScheduleStatus()326 getScalingScheduleStatus(); 327 /** 328 * 329 * 330 * <pre> 331 * [Output Only] Status information of existing scaling schedules. 332 * </pre> 333 * 334 * <code> 335 * map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178; 336 * </code> 337 */ 338 java.util.Map<java.lang.String, com.google.cloud.compute.v1.ScalingScheduleStatus> getScalingScheduleStatusMap()339 getScalingScheduleStatusMap(); 340 /** 341 * 342 * 343 * <pre> 344 * [Output Only] Status information of existing scaling schedules. 345 * </pre> 346 * 347 * <code> 348 * map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178; 349 * </code> 350 */ 351 /* nullable */ getScalingScheduleStatusOrDefault( java.lang.String key, com.google.cloud.compute.v1.ScalingScheduleStatus defaultValue)352 com.google.cloud.compute.v1.ScalingScheduleStatus getScalingScheduleStatusOrDefault( 353 java.lang.String key, 354 /* nullable */ 355 com.google.cloud.compute.v1.ScalingScheduleStatus defaultValue); 356 /** 357 * 358 * 359 * <pre> 360 * [Output Only] Status information of existing scaling schedules. 361 * </pre> 362 * 363 * <code> 364 * map<string, .google.cloud.compute.v1.ScalingScheduleStatus> scaling_schedule_status = 465950178; 365 * </code> 366 */ getScalingScheduleStatusOrThrow( java.lang.String key)367 com.google.cloud.compute.v1.ScalingScheduleStatus getScalingScheduleStatusOrThrow( 368 java.lang.String key); 369 370 /** 371 * 372 * 373 * <pre> 374 * [Output Only] Server-defined URL for the resource. 375 * </pre> 376 * 377 * <code>optional string self_link = 456214797;</code> 378 * 379 * @return Whether the selfLink field is set. 380 */ hasSelfLink()381 boolean hasSelfLink(); 382 /** 383 * 384 * 385 * <pre> 386 * [Output Only] Server-defined URL for the resource. 387 * </pre> 388 * 389 * <code>optional string self_link = 456214797;</code> 390 * 391 * @return The selfLink. 392 */ getSelfLink()393 java.lang.String getSelfLink(); 394 /** 395 * 396 * 397 * <pre> 398 * [Output Only] Server-defined URL for the resource. 399 * </pre> 400 * 401 * <code>optional string self_link = 456214797;</code> 402 * 403 * @return The bytes for selfLink. 404 */ getSelfLinkBytes()405 com.google.protobuf.ByteString getSelfLinkBytes(); 406 407 /** 408 * 409 * 410 * <pre> 411 * [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. 412 * Check the Status enum for the list of possible values. 413 * </pre> 414 * 415 * <code>optional string status = 181260274;</code> 416 * 417 * @return Whether the status field is set. 418 */ hasStatus()419 boolean hasStatus(); 420 /** 421 * 422 * 423 * <pre> 424 * [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. 425 * Check the Status enum for the list of possible values. 426 * </pre> 427 * 428 * <code>optional string status = 181260274;</code> 429 * 430 * @return The status. 431 */ getStatus()432 java.lang.String getStatus(); 433 /** 434 * 435 * 436 * <pre> 437 * [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. 438 * Check the Status enum for the list of possible values. 439 * </pre> 440 * 441 * <code>optional string status = 181260274;</code> 442 * 443 * @return The bytes for status. 444 */ getStatusBytes()445 com.google.protobuf.ByteString getStatusBytes(); 446 447 /** 448 * 449 * 450 * <pre> 451 * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. 452 * </pre> 453 * 454 * <code>repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845; 455 * </code> 456 */ getStatusDetailsList()457 java.util.List<com.google.cloud.compute.v1.AutoscalerStatusDetails> getStatusDetailsList(); 458 /** 459 * 460 * 461 * <pre> 462 * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. 463 * </pre> 464 * 465 * <code>repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845; 466 * </code> 467 */ getStatusDetails(int index)468 com.google.cloud.compute.v1.AutoscalerStatusDetails getStatusDetails(int index); 469 /** 470 * 471 * 472 * <pre> 473 * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. 474 * </pre> 475 * 476 * <code>repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845; 477 * </code> 478 */ getStatusDetailsCount()479 int getStatusDetailsCount(); 480 /** 481 * 482 * 483 * <pre> 484 * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. 485 * </pre> 486 * 487 * <code>repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845; 488 * </code> 489 */ 490 java.util.List<? extends com.google.cloud.compute.v1.AutoscalerStatusDetailsOrBuilder> getStatusDetailsOrBuilderList()491 getStatusDetailsOrBuilderList(); 492 /** 493 * 494 * 495 * <pre> 496 * [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. 497 * </pre> 498 * 499 * <code>repeated .google.cloud.compute.v1.AutoscalerStatusDetails status_details = 363353845; 500 * </code> 501 */ getStatusDetailsOrBuilder(int index)502 com.google.cloud.compute.v1.AutoscalerStatusDetailsOrBuilder getStatusDetailsOrBuilder(int index); 503 504 /** 505 * 506 * 507 * <pre> 508 * URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. 509 * </pre> 510 * 511 * <code>optional string target = 192835985;</code> 512 * 513 * @return Whether the target field is set. 514 */ hasTarget()515 boolean hasTarget(); 516 /** 517 * 518 * 519 * <pre> 520 * URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. 521 * </pre> 522 * 523 * <code>optional string target = 192835985;</code> 524 * 525 * @return The target. 526 */ getTarget()527 java.lang.String getTarget(); 528 /** 529 * 530 * 531 * <pre> 532 * URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. 533 * </pre> 534 * 535 * <code>optional string target = 192835985;</code> 536 * 537 * @return The bytes for target. 538 */ getTargetBytes()539 com.google.protobuf.ByteString getTargetBytes(); 540 541 /** 542 * 543 * 544 * <pre> 545 * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 546 * </pre> 547 * 548 * <code>optional string zone = 3744684;</code> 549 * 550 * @return Whether the zone field is set. 551 */ hasZone()552 boolean hasZone(); 553 /** 554 * 555 * 556 * <pre> 557 * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 558 * </pre> 559 * 560 * <code>optional string zone = 3744684;</code> 561 * 562 * @return The zone. 563 */ getZone()564 java.lang.String getZone(); 565 /** 566 * 567 * 568 * <pre> 569 * [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). 570 * </pre> 571 * 572 * <code>optional string zone = 3744684;</code> 573 * 574 * @return The bytes for zone. 575 */ getZoneBytes()576 com.google.protobuf.ByteString getZoneBytes(); 577 } 578