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 HealthCheckServiceOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.HealthCheckService) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * [Output Only] Creation timestamp in RFC3339 text format. 31 * </pre> 32 * 33 * <code>optional string creation_timestamp = 30525366;</code> 34 * 35 * @return Whether the creationTimestamp field is set. 36 */ hasCreationTimestamp()37 boolean hasCreationTimestamp(); 38 /** 39 * 40 * 41 * <pre> 42 * [Output Only] Creation timestamp in RFC3339 text format. 43 * </pre> 44 * 45 * <code>optional string creation_timestamp = 30525366;</code> 46 * 47 * @return The creationTimestamp. 48 */ getCreationTimestamp()49 java.lang.String getCreationTimestamp(); 50 /** 51 * 52 * 53 * <pre> 54 * [Output Only] Creation timestamp in RFC3339 text format. 55 * </pre> 56 * 57 * <code>optional string creation_timestamp = 30525366;</code> 58 * 59 * @return The bytes for creationTimestamp. 60 */ getCreationTimestampBytes()61 com.google.protobuf.ByteString getCreationTimestampBytes(); 62 63 /** 64 * 65 * 66 * <pre> 67 * An optional description of this resource. Provide this property when you create the resource. 68 * </pre> 69 * 70 * <code>optional string description = 422937596;</code> 71 * 72 * @return Whether the description field is set. 73 */ hasDescription()74 boolean hasDescription(); 75 /** 76 * 77 * 78 * <pre> 79 * An optional description of this resource. Provide this property when you create the resource. 80 * </pre> 81 * 82 * <code>optional string description = 422937596;</code> 83 * 84 * @return The description. 85 */ getDescription()86 java.lang.String getDescription(); 87 /** 88 * 89 * 90 * <pre> 91 * An optional description of this resource. Provide this property when you create the resource. 92 * </pre> 93 * 94 * <code>optional string description = 422937596;</code> 95 * 96 * @return The bytes for description. 97 */ getDescriptionBytes()98 com.google.protobuf.ByteString getDescriptionBytes(); 99 100 /** 101 * 102 * 103 * <pre> 104 * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. 105 * </pre> 106 * 107 * <code>optional string fingerprint = 234678500;</code> 108 * 109 * @return Whether the fingerprint field is set. 110 */ hasFingerprint()111 boolean hasFingerprint(); 112 /** 113 * 114 * 115 * <pre> 116 * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. 117 * </pre> 118 * 119 * <code>optional string fingerprint = 234678500;</code> 120 * 121 * @return The fingerprint. 122 */ getFingerprint()123 java.lang.String getFingerprint(); 124 /** 125 * 126 * 127 * <pre> 128 * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. 129 * </pre> 130 * 131 * <code>optional string fingerprint = 234678500;</code> 132 * 133 * @return The bytes for fingerprint. 134 */ getFingerprintBytes()135 com.google.protobuf.ByteString getFingerprintBytes(); 136 137 /** 138 * 139 * 140 * <pre> 141 * A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups. 142 * </pre> 143 * 144 * <code>repeated string health_checks = 448370606;</code> 145 * 146 * @return A list containing the healthChecks. 147 */ getHealthChecksList()148 java.util.List<java.lang.String> getHealthChecksList(); 149 /** 150 * 151 * 152 * <pre> 153 * A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups. 154 * </pre> 155 * 156 * <code>repeated string health_checks = 448370606;</code> 157 * 158 * @return The count of healthChecks. 159 */ getHealthChecksCount()160 int getHealthChecksCount(); 161 /** 162 * 163 * 164 * <pre> 165 * A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups. 166 * </pre> 167 * 168 * <code>repeated string health_checks = 448370606;</code> 169 * 170 * @param index The index of the element to return. 171 * @return The healthChecks at the given index. 172 */ getHealthChecks(int index)173 java.lang.String getHealthChecks(int index); 174 /** 175 * 176 * 177 * <pre> 178 * A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups. 179 * </pre> 180 * 181 * <code>repeated string health_checks = 448370606;</code> 182 * 183 * @param index The index of the value to return. 184 * @return The bytes of the healthChecks at the given index. 185 */ getHealthChecksBytes(int index)186 com.google.protobuf.ByteString getHealthChecksBytes(int index); 187 188 /** 189 * 190 * 191 * <pre> 192 * Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. 193 * Check the HealthStatusAggregationPolicy enum for the list of possible values. 194 * </pre> 195 * 196 * <code>optional string health_status_aggregation_policy = 253163129;</code> 197 * 198 * @return Whether the healthStatusAggregationPolicy field is set. 199 */ hasHealthStatusAggregationPolicy()200 boolean hasHealthStatusAggregationPolicy(); 201 /** 202 * 203 * 204 * <pre> 205 * Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. 206 * Check the HealthStatusAggregationPolicy enum for the list of possible values. 207 * </pre> 208 * 209 * <code>optional string health_status_aggregation_policy = 253163129;</code> 210 * 211 * @return The healthStatusAggregationPolicy. 212 */ getHealthStatusAggregationPolicy()213 java.lang.String getHealthStatusAggregationPolicy(); 214 /** 215 * 216 * 217 * <pre> 218 * Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. 219 * Check the HealthStatusAggregationPolicy enum for the list of possible values. 220 * </pre> 221 * 222 * <code>optional string health_status_aggregation_policy = 253163129;</code> 223 * 224 * @return The bytes for healthStatusAggregationPolicy. 225 */ getHealthStatusAggregationPolicyBytes()226 com.google.protobuf.ByteString getHealthStatusAggregationPolicyBytes(); 227 228 /** 229 * 230 * 231 * <pre> 232 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 233 * </pre> 234 * 235 * <code>optional uint64 id = 3355;</code> 236 * 237 * @return Whether the id field is set. 238 */ hasId()239 boolean hasId(); 240 /** 241 * 242 * 243 * <pre> 244 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 245 * </pre> 246 * 247 * <code>optional uint64 id = 3355;</code> 248 * 249 * @return The id. 250 */ getId()251 long getId(); 252 253 /** 254 * 255 * 256 * <pre> 257 * [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. 258 * </pre> 259 * 260 * <code>optional string kind = 3292052;</code> 261 * 262 * @return Whether the kind field is set. 263 */ hasKind()264 boolean hasKind(); 265 /** 266 * 267 * 268 * <pre> 269 * [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. 270 * </pre> 271 * 272 * <code>optional string kind = 3292052;</code> 273 * 274 * @return The kind. 275 */ getKind()276 java.lang.String getKind(); 277 /** 278 * 279 * 280 * <pre> 281 * [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. 282 * </pre> 283 * 284 * <code>optional string kind = 3292052;</code> 285 * 286 * @return The bytes for kind. 287 */ getKindBytes()288 com.google.protobuf.ByteString getKindBytes(); 289 290 /** 291 * 292 * 293 * <pre> 294 * Name of the resource. 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. 295 * </pre> 296 * 297 * <code>optional string name = 3373707;</code> 298 * 299 * @return Whether the name field is set. 300 */ hasName()301 boolean hasName(); 302 /** 303 * 304 * 305 * <pre> 306 * Name of the resource. 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. 307 * </pre> 308 * 309 * <code>optional string name = 3373707;</code> 310 * 311 * @return The name. 312 */ getName()313 java.lang.String getName(); 314 /** 315 * 316 * 317 * <pre> 318 * Name of the resource. 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. 319 * </pre> 320 * 321 * <code>optional string name = 3373707;</code> 322 * 323 * @return The bytes for name. 324 */ getNameBytes()325 com.google.protobuf.ByteString getNameBytes(); 326 327 /** 328 * 329 * 330 * <pre> 331 * A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. 332 * </pre> 333 * 334 * <code>repeated string network_endpoint_groups = 29346733;</code> 335 * 336 * @return A list containing the networkEndpointGroups. 337 */ getNetworkEndpointGroupsList()338 java.util.List<java.lang.String> getNetworkEndpointGroupsList(); 339 /** 340 * 341 * 342 * <pre> 343 * A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. 344 * </pre> 345 * 346 * <code>repeated string network_endpoint_groups = 29346733;</code> 347 * 348 * @return The count of networkEndpointGroups. 349 */ getNetworkEndpointGroupsCount()350 int getNetworkEndpointGroupsCount(); 351 /** 352 * 353 * 354 * <pre> 355 * A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. 356 * </pre> 357 * 358 * <code>repeated string network_endpoint_groups = 29346733;</code> 359 * 360 * @param index The index of the element to return. 361 * @return The networkEndpointGroups at the given index. 362 */ getNetworkEndpointGroups(int index)363 java.lang.String getNetworkEndpointGroups(int index); 364 /** 365 * 366 * 367 * <pre> 368 * A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. 369 * </pre> 370 * 371 * <code>repeated string network_endpoint_groups = 29346733;</code> 372 * 373 * @param index The index of the value to return. 374 * @return The bytes of the networkEndpointGroups at the given index. 375 */ getNetworkEndpointGroupsBytes(int index)376 com.google.protobuf.ByteString getNetworkEndpointGroupsBytes(int index); 377 378 /** 379 * 380 * 381 * <pre> 382 * A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. 383 * </pre> 384 * 385 * <code>repeated string notification_endpoints = 406728490;</code> 386 * 387 * @return A list containing the notificationEndpoints. 388 */ getNotificationEndpointsList()389 java.util.List<java.lang.String> getNotificationEndpointsList(); 390 /** 391 * 392 * 393 * <pre> 394 * A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. 395 * </pre> 396 * 397 * <code>repeated string notification_endpoints = 406728490;</code> 398 * 399 * @return The count of notificationEndpoints. 400 */ getNotificationEndpointsCount()401 int getNotificationEndpointsCount(); 402 /** 403 * 404 * 405 * <pre> 406 * A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. 407 * </pre> 408 * 409 * <code>repeated string notification_endpoints = 406728490;</code> 410 * 411 * @param index The index of the element to return. 412 * @return The notificationEndpoints at the given index. 413 */ getNotificationEndpoints(int index)414 java.lang.String getNotificationEndpoints(int index); 415 /** 416 * 417 * 418 * <pre> 419 * A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. 420 * </pre> 421 * 422 * <code>repeated string notification_endpoints = 406728490;</code> 423 * 424 * @param index The index of the value to return. 425 * @return The bytes of the notificationEndpoints at the given index. 426 */ getNotificationEndpointsBytes(int index)427 com.google.protobuf.ByteString getNotificationEndpointsBytes(int index); 428 429 /** 430 * 431 * 432 * <pre> 433 * [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 434 * </pre> 435 * 436 * <code>optional string region = 138946292;</code> 437 * 438 * @return Whether the region field is set. 439 */ hasRegion()440 boolean hasRegion(); 441 /** 442 * 443 * 444 * <pre> 445 * [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 446 * </pre> 447 * 448 * <code>optional string region = 138946292;</code> 449 * 450 * @return The region. 451 */ getRegion()452 java.lang.String getRegion(); 453 /** 454 * 455 * 456 * <pre> 457 * [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. 458 * </pre> 459 * 460 * <code>optional string region = 138946292;</code> 461 * 462 * @return The bytes for region. 463 */ getRegionBytes()464 com.google.protobuf.ByteString getRegionBytes(); 465 466 /** 467 * 468 * 469 * <pre> 470 * [Output Only] Server-defined URL for the resource. 471 * </pre> 472 * 473 * <code>optional string self_link = 456214797;</code> 474 * 475 * @return Whether the selfLink field is set. 476 */ hasSelfLink()477 boolean hasSelfLink(); 478 /** 479 * 480 * 481 * <pre> 482 * [Output Only] Server-defined URL for the resource. 483 * </pre> 484 * 485 * <code>optional string self_link = 456214797;</code> 486 * 487 * @return The selfLink. 488 */ getSelfLink()489 java.lang.String getSelfLink(); 490 /** 491 * 492 * 493 * <pre> 494 * [Output Only] Server-defined URL for the resource. 495 * </pre> 496 * 497 * <code>optional string self_link = 456214797;</code> 498 * 499 * @return The bytes for selfLink. 500 */ getSelfLinkBytes()501 com.google.protobuf.ByteString getSelfLinkBytes(); 502 } 503