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 HealthCheckOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.HealthCheck) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * How often (in seconds) to send a health check. The default value is 5 seconds. 31 * </pre> 32 * 33 * <code>optional int32 check_interval_sec = 345561006;</code> 34 * 35 * @return Whether the checkIntervalSec field is set. 36 */ hasCheckIntervalSec()37 boolean hasCheckIntervalSec(); 38 /** 39 * 40 * 41 * <pre> 42 * How often (in seconds) to send a health check. The default value is 5 seconds. 43 * </pre> 44 * 45 * <code>optional int32 check_interval_sec = 345561006;</code> 46 * 47 * @return The checkIntervalSec. 48 */ getCheckIntervalSec()49 int getCheckIntervalSec(); 50 51 /** 52 * 53 * 54 * <pre> 55 * [Output Only] Creation timestamp in 3339 text format. 56 * </pre> 57 * 58 * <code>optional string creation_timestamp = 30525366;</code> 59 * 60 * @return Whether the creationTimestamp field is set. 61 */ hasCreationTimestamp()62 boolean hasCreationTimestamp(); 63 /** 64 * 65 * 66 * <pre> 67 * [Output Only] Creation timestamp in 3339 text format. 68 * </pre> 69 * 70 * <code>optional string creation_timestamp = 30525366;</code> 71 * 72 * @return The creationTimestamp. 73 */ getCreationTimestamp()74 java.lang.String getCreationTimestamp(); 75 /** 76 * 77 * 78 * <pre> 79 * [Output Only] Creation timestamp in 3339 text format. 80 * </pre> 81 * 82 * <code>optional string creation_timestamp = 30525366;</code> 83 * 84 * @return The bytes for creationTimestamp. 85 */ getCreationTimestampBytes()86 com.google.protobuf.ByteString getCreationTimestampBytes(); 87 88 /** 89 * 90 * 91 * <pre> 92 * An optional description of this resource. Provide this property when you create the resource. 93 * </pre> 94 * 95 * <code>optional string description = 422937596;</code> 96 * 97 * @return Whether the description field is set. 98 */ hasDescription()99 boolean hasDescription(); 100 /** 101 * 102 * 103 * <pre> 104 * An optional description of this resource. Provide this property when you create the resource. 105 * </pre> 106 * 107 * <code>optional string description = 422937596;</code> 108 * 109 * @return The description. 110 */ getDescription()111 java.lang.String getDescription(); 112 /** 113 * 114 * 115 * <pre> 116 * An optional description of this resource. Provide this property when you create the resource. 117 * </pre> 118 * 119 * <code>optional string description = 422937596;</code> 120 * 121 * @return The bytes for description. 122 */ getDescriptionBytes()123 com.google.protobuf.ByteString getDescriptionBytes(); 124 125 /** 126 * <code>optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;</code> 127 * 128 * @return Whether the grpcHealthCheck field is set. 129 */ hasGrpcHealthCheck()130 boolean hasGrpcHealthCheck(); 131 /** 132 * <code>optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;</code> 133 * 134 * @return The grpcHealthCheck. 135 */ getGrpcHealthCheck()136 com.google.cloud.compute.v1.GRPCHealthCheck getGrpcHealthCheck(); 137 /** 138 * <code>optional .google.cloud.compute.v1.GRPCHealthCheck grpc_health_check = 85529574;</code> 139 */ getGrpcHealthCheckOrBuilder()140 com.google.cloud.compute.v1.GRPCHealthCheckOrBuilder getGrpcHealthCheckOrBuilder(); 141 142 /** 143 * 144 * 145 * <pre> 146 * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 147 * </pre> 148 * 149 * <code>optional int32 healthy_threshold = 403212361;</code> 150 * 151 * @return Whether the healthyThreshold field is set. 152 */ hasHealthyThreshold()153 boolean hasHealthyThreshold(); 154 /** 155 * 156 * 157 * <pre> 158 * A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. 159 * </pre> 160 * 161 * <code>optional int32 healthy_threshold = 403212361;</code> 162 * 163 * @return The healthyThreshold. 164 */ getHealthyThreshold()165 int getHealthyThreshold(); 166 167 /** 168 * <code>optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;</code> 169 * 170 * @return Whether the http2HealthCheck field is set. 171 */ hasHttp2HealthCheck()172 boolean hasHttp2HealthCheck(); 173 /** 174 * <code>optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;</code> 175 * 176 * @return The http2HealthCheck. 177 */ getHttp2HealthCheck()178 com.google.cloud.compute.v1.HTTP2HealthCheck getHttp2HealthCheck(); 179 /** 180 * <code>optional .google.cloud.compute.v1.HTTP2HealthCheck http2_health_check = 11360986;</code> 181 */ getHttp2HealthCheckOrBuilder()182 com.google.cloud.compute.v1.HTTP2HealthCheckOrBuilder getHttp2HealthCheckOrBuilder(); 183 184 /** 185 * <code>optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;</code> 186 * 187 * @return Whether the httpHealthCheck field is set. 188 */ hasHttpHealthCheck()189 boolean hasHttpHealthCheck(); 190 /** 191 * <code>optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;</code> 192 * 193 * @return The httpHealthCheck. 194 */ getHttpHealthCheck()195 com.google.cloud.compute.v1.HTTPHealthCheck getHttpHealthCheck(); 196 /** 197 * <code>optional .google.cloud.compute.v1.HTTPHealthCheck http_health_check = 412586940;</code> 198 */ getHttpHealthCheckOrBuilder()199 com.google.cloud.compute.v1.HTTPHealthCheckOrBuilder getHttpHealthCheckOrBuilder(); 200 201 /** 202 * <code>optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;</code> 203 * 204 * @return Whether the httpsHealthCheck field is set. 205 */ hasHttpsHealthCheck()206 boolean hasHttpsHealthCheck(); 207 /** 208 * <code>optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;</code> 209 * 210 * @return The httpsHealthCheck. 211 */ getHttpsHealthCheck()212 com.google.cloud.compute.v1.HTTPSHealthCheck getHttpsHealthCheck(); 213 /** 214 * <code>optional .google.cloud.compute.v1.HTTPSHealthCheck https_health_check = 436046905;</code> 215 */ getHttpsHealthCheckOrBuilder()216 com.google.cloud.compute.v1.HTTPSHealthCheckOrBuilder getHttpsHealthCheckOrBuilder(); 217 218 /** 219 * 220 * 221 * <pre> 222 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 223 * </pre> 224 * 225 * <code>optional uint64 id = 3355;</code> 226 * 227 * @return Whether the id field is set. 228 */ hasId()229 boolean hasId(); 230 /** 231 * 232 * 233 * <pre> 234 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 235 * </pre> 236 * 237 * <code>optional uint64 id = 3355;</code> 238 * 239 * @return The id. 240 */ getId()241 long getId(); 242 243 /** 244 * 245 * 246 * <pre> 247 * Type of the resource. 248 * </pre> 249 * 250 * <code>optional string kind = 3292052;</code> 251 * 252 * @return Whether the kind field is set. 253 */ hasKind()254 boolean hasKind(); 255 /** 256 * 257 * 258 * <pre> 259 * Type of the resource. 260 * </pre> 261 * 262 * <code>optional string kind = 3292052;</code> 263 * 264 * @return The kind. 265 */ getKind()266 java.lang.String getKind(); 267 /** 268 * 269 * 270 * <pre> 271 * Type of the resource. 272 * </pre> 273 * 274 * <code>optional string kind = 3292052;</code> 275 * 276 * @return The bytes for kind. 277 */ getKindBytes()278 com.google.protobuf.ByteString getKindBytes(); 279 280 /** 281 * 282 * 283 * <pre> 284 * Configure logging on this health check. 285 * </pre> 286 * 287 * <code>optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;</code> 288 * 289 * @return Whether the logConfig field is set. 290 */ hasLogConfig()291 boolean hasLogConfig(); 292 /** 293 * 294 * 295 * <pre> 296 * Configure logging on this health check. 297 * </pre> 298 * 299 * <code>optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;</code> 300 * 301 * @return The logConfig. 302 */ getLogConfig()303 com.google.cloud.compute.v1.HealthCheckLogConfig getLogConfig(); 304 /** 305 * 306 * 307 * <pre> 308 * Configure logging on this health check. 309 * </pre> 310 * 311 * <code>optional .google.cloud.compute.v1.HealthCheckLogConfig log_config = 351299741;</code> 312 */ getLogConfigOrBuilder()313 com.google.cloud.compute.v1.HealthCheckLogConfigOrBuilder getLogConfigOrBuilder(); 314 315 /** 316 * 317 * 318 * <pre> 319 * 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. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. 320 * </pre> 321 * 322 * <code>optional string name = 3373707;</code> 323 * 324 * @return Whether the name field is set. 325 */ hasName()326 boolean hasName(); 327 /** 328 * 329 * 330 * <pre> 331 * 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. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. 332 * </pre> 333 * 334 * <code>optional string name = 3373707;</code> 335 * 336 * @return The name. 337 */ getName()338 java.lang.String getName(); 339 /** 340 * 341 * 342 * <pre> 343 * 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. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. 344 * </pre> 345 * 346 * <code>optional string name = 3373707;</code> 347 * 348 * @return The bytes for name. 349 */ getNameBytes()350 com.google.protobuf.ByteString getNameBytes(); 351 352 /** 353 * 354 * 355 * <pre> 356 * [Output Only] Region where the health check resides. Not applicable to global health checks. 357 * </pre> 358 * 359 * <code>optional string region = 138946292;</code> 360 * 361 * @return Whether the region field is set. 362 */ hasRegion()363 boolean hasRegion(); 364 /** 365 * 366 * 367 * <pre> 368 * [Output Only] Region where the health check resides. Not applicable to global health checks. 369 * </pre> 370 * 371 * <code>optional string region = 138946292;</code> 372 * 373 * @return The region. 374 */ getRegion()375 java.lang.String getRegion(); 376 /** 377 * 378 * 379 * <pre> 380 * [Output Only] Region where the health check resides. Not applicable to global health checks. 381 * </pre> 382 * 383 * <code>optional string region = 138946292;</code> 384 * 385 * @return The bytes for region. 386 */ getRegionBytes()387 com.google.protobuf.ByteString getRegionBytes(); 388 389 /** 390 * 391 * 392 * <pre> 393 * [Output Only] Server-defined URL for the resource. 394 * </pre> 395 * 396 * <code>optional string self_link = 456214797;</code> 397 * 398 * @return Whether the selfLink field is set. 399 */ hasSelfLink()400 boolean hasSelfLink(); 401 /** 402 * 403 * 404 * <pre> 405 * [Output Only] Server-defined URL for the resource. 406 * </pre> 407 * 408 * <code>optional string self_link = 456214797;</code> 409 * 410 * @return The selfLink. 411 */ getSelfLink()412 java.lang.String getSelfLink(); 413 /** 414 * 415 * 416 * <pre> 417 * [Output Only] Server-defined URL for the resource. 418 * </pre> 419 * 420 * <code>optional string self_link = 456214797;</code> 421 * 422 * @return The bytes for selfLink. 423 */ getSelfLinkBytes()424 com.google.protobuf.ByteString getSelfLinkBytes(); 425 426 /** 427 * <code>optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;</code> 428 * 429 * @return Whether the sslHealthCheck field is set. 430 */ hasSslHealthCheck()431 boolean hasSslHealthCheck(); 432 /** 433 * <code>optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;</code> 434 * 435 * @return The sslHealthCheck. 436 */ getSslHealthCheck()437 com.google.cloud.compute.v1.SSLHealthCheck getSslHealthCheck(); 438 /** <code>optional .google.cloud.compute.v1.SSLHealthCheck ssl_health_check = 280032440;</code> */ getSslHealthCheckOrBuilder()439 com.google.cloud.compute.v1.SSLHealthCheckOrBuilder getSslHealthCheckOrBuilder(); 440 441 /** 442 * <code>optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;</code> 443 * 444 * @return Whether the tcpHealthCheck field is set. 445 */ hasTcpHealthCheck()446 boolean hasTcpHealthCheck(); 447 /** 448 * <code>optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;</code> 449 * 450 * @return The tcpHealthCheck. 451 */ getTcpHealthCheck()452 com.google.cloud.compute.v1.TCPHealthCheck getTcpHealthCheck(); 453 /** <code>optional .google.cloud.compute.v1.TCPHealthCheck tcp_health_check = 469980419;</code> */ getTcpHealthCheckOrBuilder()454 com.google.cloud.compute.v1.TCPHealthCheckOrBuilder getTcpHealthCheckOrBuilder(); 455 456 /** 457 * 458 * 459 * <pre> 460 * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 461 * </pre> 462 * 463 * <code>optional int32 timeout_sec = 79994995;</code> 464 * 465 * @return Whether the timeoutSec field is set. 466 */ hasTimeoutSec()467 boolean hasTimeoutSec(); 468 /** 469 * 470 * 471 * <pre> 472 * How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. 473 * </pre> 474 * 475 * <code>optional int32 timeout_sec = 79994995;</code> 476 * 477 * @return The timeoutSec. 478 */ getTimeoutSec()479 int getTimeoutSec(); 480 481 /** 482 * 483 * 484 * <pre> 485 * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. 486 * Check the Type enum for the list of possible values. 487 * </pre> 488 * 489 * <code>optional string type = 3575610;</code> 490 * 491 * @return Whether the type field is set. 492 */ hasType()493 boolean hasType(); 494 /** 495 * 496 * 497 * <pre> 498 * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. 499 * Check the Type enum for the list of possible values. 500 * </pre> 501 * 502 * <code>optional string type = 3575610;</code> 503 * 504 * @return The type. 505 */ getType()506 java.lang.String getType(); 507 /** 508 * 509 * 510 * <pre> 511 * Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. 512 * Check the Type enum for the list of possible values. 513 * </pre> 514 * 515 * <code>optional string type = 3575610;</code> 516 * 517 * @return The bytes for type. 518 */ getTypeBytes()519 com.google.protobuf.ByteString getTypeBytes(); 520 521 /** 522 * 523 * 524 * <pre> 525 * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 526 * </pre> 527 * 528 * <code>optional int32 unhealthy_threshold = 227958480;</code> 529 * 530 * @return Whether the unhealthyThreshold field is set. 531 */ hasUnhealthyThreshold()532 boolean hasUnhealthyThreshold(); 533 /** 534 * 535 * 536 * <pre> 537 * A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. 538 * </pre> 539 * 540 * <code>optional int32 unhealthy_threshold = 227958480;</code> 541 * 542 * @return The unhealthyThreshold. 543 */ getUnhealthyThreshold()544 int getUnhealthyThreshold(); 545 } 546