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 NetworkEndpointGroupOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.NetworkEndpointGroup) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Metadata defined as annotations on the network endpoint group. 31 * </pre> 32 * 33 * <code>map<string, string> annotations = 112032548;</code> 34 */ getAnnotationsCount()35 int getAnnotationsCount(); 36 /** 37 * 38 * 39 * <pre> 40 * Metadata defined as annotations on the network endpoint group. 41 * </pre> 42 * 43 * <code>map<string, string> annotations = 112032548;</code> 44 */ containsAnnotations(java.lang.String key)45 boolean containsAnnotations(java.lang.String key); 46 /** Use {@link #getAnnotationsMap()} instead. */ 47 @java.lang.Deprecated getAnnotations()48 java.util.Map<java.lang.String, java.lang.String> getAnnotations(); 49 /** 50 * 51 * 52 * <pre> 53 * Metadata defined as annotations on the network endpoint group. 54 * </pre> 55 * 56 * <code>map<string, string> annotations = 112032548;</code> 57 */ getAnnotationsMap()58 java.util.Map<java.lang.String, java.lang.String> getAnnotationsMap(); 59 /** 60 * 61 * 62 * <pre> 63 * Metadata defined as annotations on the network endpoint group. 64 * </pre> 65 * 66 * <code>map<string, string> annotations = 112032548;</code> 67 */ 68 /* nullable */ getAnnotationsOrDefault( java.lang.String key, java.lang.String defaultValue)69 java.lang.String getAnnotationsOrDefault( 70 java.lang.String key, 71 /* nullable */ 72 java.lang.String defaultValue); 73 /** 74 * 75 * 76 * <pre> 77 * Metadata defined as annotations on the network endpoint group. 78 * </pre> 79 * 80 * <code>map<string, string> annotations = 112032548;</code> 81 */ getAnnotationsOrThrow(java.lang.String key)82 java.lang.String getAnnotationsOrThrow(java.lang.String key); 83 84 /** 85 * 86 * 87 * <pre> 88 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 89 * </pre> 90 * 91 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768; 92 * </code> 93 * 94 * @return Whether the appEngine field is set. 95 */ hasAppEngine()96 boolean hasAppEngine(); 97 /** 98 * 99 * 100 * <pre> 101 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 102 * </pre> 103 * 104 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768; 105 * </code> 106 * 107 * @return The appEngine. 108 */ getAppEngine()109 com.google.cloud.compute.v1.NetworkEndpointGroupAppEngine getAppEngine(); 110 /** 111 * 112 * 113 * <pre> 114 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 115 * </pre> 116 * 117 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupAppEngine app_engine = 340788768; 118 * </code> 119 */ getAppEngineOrBuilder()120 com.google.cloud.compute.v1.NetworkEndpointGroupAppEngineOrBuilder getAppEngineOrBuilder(); 121 122 /** 123 * 124 * 125 * <pre> 126 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 127 * </pre> 128 * 129 * <code> 130 * optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666; 131 * </code> 132 * 133 * @return Whether the cloudFunction field is set. 134 */ hasCloudFunction()135 boolean hasCloudFunction(); 136 /** 137 * 138 * 139 * <pre> 140 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 141 * </pre> 142 * 143 * <code> 144 * optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666; 145 * </code> 146 * 147 * @return The cloudFunction. 148 */ getCloudFunction()149 com.google.cloud.compute.v1.NetworkEndpointGroupCloudFunction getCloudFunction(); 150 /** 151 * 152 * 153 * <pre> 154 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 155 * </pre> 156 * 157 * <code> 158 * optional .google.cloud.compute.v1.NetworkEndpointGroupCloudFunction cloud_function = 519893666; 159 * </code> 160 */ 161 com.google.cloud.compute.v1.NetworkEndpointGroupCloudFunctionOrBuilder getCloudFunctionOrBuilder()162 getCloudFunctionOrBuilder(); 163 164 /** 165 * 166 * 167 * <pre> 168 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 169 * </pre> 170 * 171 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353; 172 * </code> 173 * 174 * @return Whether the cloudRun field is set. 175 */ hasCloudRun()176 boolean hasCloudRun(); 177 /** 178 * 179 * 180 * <pre> 181 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 182 * </pre> 183 * 184 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353; 185 * </code> 186 * 187 * @return The cloudRun. 188 */ getCloudRun()189 com.google.cloud.compute.v1.NetworkEndpointGroupCloudRun getCloudRun(); 190 /** 191 * 192 * 193 * <pre> 194 * Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set. 195 * </pre> 196 * 197 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupCloudRun cloud_run = 111060353; 198 * </code> 199 */ getCloudRunOrBuilder()200 com.google.cloud.compute.v1.NetworkEndpointGroupCloudRunOrBuilder getCloudRunOrBuilder(); 201 202 /** 203 * 204 * 205 * <pre> 206 * [Output Only] Creation timestamp in RFC3339 text format. 207 * </pre> 208 * 209 * <code>optional string creation_timestamp = 30525366;</code> 210 * 211 * @return Whether the creationTimestamp field is set. 212 */ hasCreationTimestamp()213 boolean hasCreationTimestamp(); 214 /** 215 * 216 * 217 * <pre> 218 * [Output Only] Creation timestamp in RFC3339 text format. 219 * </pre> 220 * 221 * <code>optional string creation_timestamp = 30525366;</code> 222 * 223 * @return The creationTimestamp. 224 */ getCreationTimestamp()225 java.lang.String getCreationTimestamp(); 226 /** 227 * 228 * 229 * <pre> 230 * [Output Only] Creation timestamp in RFC3339 text format. 231 * </pre> 232 * 233 * <code>optional string creation_timestamp = 30525366;</code> 234 * 235 * @return The bytes for creationTimestamp. 236 */ getCreationTimestampBytes()237 com.google.protobuf.ByteString getCreationTimestampBytes(); 238 239 /** 240 * 241 * 242 * <pre> 243 * The default port used if the port number is not specified in the network endpoint. 244 * </pre> 245 * 246 * <code>optional int32 default_port = 423377855;</code> 247 * 248 * @return Whether the defaultPort field is set. 249 */ hasDefaultPort()250 boolean hasDefaultPort(); 251 /** 252 * 253 * 254 * <pre> 255 * The default port used if the port number is not specified in the network endpoint. 256 * </pre> 257 * 258 * <code>optional int32 default_port = 423377855;</code> 259 * 260 * @return The defaultPort. 261 */ getDefaultPort()262 int getDefaultPort(); 263 264 /** 265 * 266 * 267 * <pre> 268 * An optional description of this resource. Provide this property when you create the resource. 269 * </pre> 270 * 271 * <code>optional string description = 422937596;</code> 272 * 273 * @return Whether the description field is set. 274 */ hasDescription()275 boolean hasDescription(); 276 /** 277 * 278 * 279 * <pre> 280 * An optional description of this resource. Provide this property when you create the resource. 281 * </pre> 282 * 283 * <code>optional string description = 422937596;</code> 284 * 285 * @return The description. 286 */ getDescription()287 java.lang.String getDescription(); 288 /** 289 * 290 * 291 * <pre> 292 * An optional description of this resource. Provide this property when you create the resource. 293 * </pre> 294 * 295 * <code>optional string description = 422937596;</code> 296 * 297 * @return The bytes for description. 298 */ getDescriptionBytes()299 com.google.protobuf.ByteString getDescriptionBytes(); 300 301 /** 302 * 303 * 304 * <pre> 305 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 306 * </pre> 307 * 308 * <code>optional uint64 id = 3355;</code> 309 * 310 * @return Whether the id field is set. 311 */ hasId()312 boolean hasId(); 313 /** 314 * 315 * 316 * <pre> 317 * [Output Only] The unique identifier for the resource. This identifier is defined by the server. 318 * </pre> 319 * 320 * <code>optional uint64 id = 3355;</code> 321 * 322 * @return The id. 323 */ getId()324 long getId(); 325 326 /** 327 * 328 * 329 * <pre> 330 * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 331 * </pre> 332 * 333 * <code>optional string kind = 3292052;</code> 334 * 335 * @return Whether the kind field is set. 336 */ hasKind()337 boolean hasKind(); 338 /** 339 * 340 * 341 * <pre> 342 * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 343 * </pre> 344 * 345 * <code>optional string kind = 3292052;</code> 346 * 347 * @return The kind. 348 */ getKind()349 java.lang.String getKind(); 350 /** 351 * 352 * 353 * <pre> 354 * [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. 355 * </pre> 356 * 357 * <code>optional string kind = 3292052;</code> 358 * 359 * @return The bytes for kind. 360 */ getKindBytes()361 com.google.protobuf.ByteString getKindBytes(); 362 363 /** 364 * 365 * 366 * <pre> 367 * 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. 368 * </pre> 369 * 370 * <code>optional string name = 3373707;</code> 371 * 372 * @return Whether the name field is set. 373 */ hasName()374 boolean hasName(); 375 /** 376 * 377 * 378 * <pre> 379 * 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. 380 * </pre> 381 * 382 * <code>optional string name = 3373707;</code> 383 * 384 * @return The name. 385 */ getName()386 java.lang.String getName(); 387 /** 388 * 389 * 390 * <pre> 391 * 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. 392 * </pre> 393 * 394 * <code>optional string name = 3373707;</code> 395 * 396 * @return The bytes for name. 397 */ getNameBytes()398 com.google.protobuf.ByteString getNameBytes(); 399 400 /** 401 * 402 * 403 * <pre> 404 * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 405 * </pre> 406 * 407 * <code>optional string network = 232872494;</code> 408 * 409 * @return Whether the network field is set. 410 */ hasNetwork()411 boolean hasNetwork(); 412 /** 413 * 414 * 415 * <pre> 416 * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 417 * </pre> 418 * 419 * <code>optional string network = 232872494;</code> 420 * 421 * @return The network. 422 */ getNetwork()423 java.lang.String getNetwork(); 424 /** 425 * 426 * 427 * <pre> 428 * The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. 429 * </pre> 430 * 431 * <code>optional string network = 232872494;</code> 432 * 433 * @return The bytes for network. 434 */ getNetworkBytes()435 com.google.protobuf.ByteString getNetworkBytes(); 436 437 /** 438 * 439 * 440 * <pre> 441 * Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. 442 * Check the NetworkEndpointType enum for the list of possible values. 443 * </pre> 444 * 445 * <code>optional string network_endpoint_type = 118301523;</code> 446 * 447 * @return Whether the networkEndpointType field is set. 448 */ hasNetworkEndpointType()449 boolean hasNetworkEndpointType(); 450 /** 451 * 452 * 453 * <pre> 454 * Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. 455 * Check the NetworkEndpointType enum for the list of possible values. 456 * </pre> 457 * 458 * <code>optional string network_endpoint_type = 118301523;</code> 459 * 460 * @return The networkEndpointType. 461 */ getNetworkEndpointType()462 java.lang.String getNetworkEndpointType(); 463 /** 464 * 465 * 466 * <pre> 467 * Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. 468 * Check the NetworkEndpointType enum for the list of possible values. 469 * </pre> 470 * 471 * <code>optional string network_endpoint_type = 118301523;</code> 472 * 473 * @return The bytes for networkEndpointType. 474 */ getNetworkEndpointTypeBytes()475 com.google.protobuf.ByteString getNetworkEndpointTypeBytes(); 476 477 /** 478 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;</code> 479 * 480 * @return Whether the pscData field is set. 481 */ hasPscData()482 boolean hasPscData(); 483 /** 484 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;</code> 485 * 486 * @return The pscData. 487 */ getPscData()488 com.google.cloud.compute.v1.NetworkEndpointGroupPscData getPscData(); 489 /** 490 * <code>optional .google.cloud.compute.v1.NetworkEndpointGroupPscData psc_data = 71937481;</code> 491 */ getPscDataOrBuilder()492 com.google.cloud.compute.v1.NetworkEndpointGroupPscDataOrBuilder getPscDataOrBuilder(); 493 494 /** 495 * 496 * 497 * <pre> 498 * The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" 499 * </pre> 500 * 501 * <code>optional string psc_target_service = 269132134;</code> 502 * 503 * @return Whether the pscTargetService field is set. 504 */ hasPscTargetService()505 boolean hasPscTargetService(); 506 /** 507 * 508 * 509 * <pre> 510 * The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" 511 * </pre> 512 * 513 * <code>optional string psc_target_service = 269132134;</code> 514 * 515 * @return The pscTargetService. 516 */ getPscTargetService()517 java.lang.String getPscTargetService(); 518 /** 519 * 520 * 521 * <pre> 522 * The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" 523 * </pre> 524 * 525 * <code>optional string psc_target_service = 269132134;</code> 526 * 527 * @return The bytes for pscTargetService. 528 */ getPscTargetServiceBytes()529 com.google.protobuf.ByteString getPscTargetServiceBytes(); 530 531 /** 532 * 533 * 534 * <pre> 535 * [Output Only] The URL of the region where the network endpoint group is located. 536 * </pre> 537 * 538 * <code>optional string region = 138946292;</code> 539 * 540 * @return Whether the region field is set. 541 */ hasRegion()542 boolean hasRegion(); 543 /** 544 * 545 * 546 * <pre> 547 * [Output Only] The URL of the region where the network endpoint group is located. 548 * </pre> 549 * 550 * <code>optional string region = 138946292;</code> 551 * 552 * @return The region. 553 */ getRegion()554 java.lang.String getRegion(); 555 /** 556 * 557 * 558 * <pre> 559 * [Output Only] The URL of the region where the network endpoint group is located. 560 * </pre> 561 * 562 * <code>optional string region = 138946292;</code> 563 * 564 * @return The bytes for region. 565 */ getRegionBytes()566 com.google.protobuf.ByteString getRegionBytes(); 567 568 /** 569 * 570 * 571 * <pre> 572 * [Output Only] Server-defined URL for the resource. 573 * </pre> 574 * 575 * <code>optional string self_link = 456214797;</code> 576 * 577 * @return Whether the selfLink field is set. 578 */ hasSelfLink()579 boolean hasSelfLink(); 580 /** 581 * 582 * 583 * <pre> 584 * [Output Only] Server-defined URL for the resource. 585 * </pre> 586 * 587 * <code>optional string self_link = 456214797;</code> 588 * 589 * @return The selfLink. 590 */ getSelfLink()591 java.lang.String getSelfLink(); 592 /** 593 * 594 * 595 * <pre> 596 * [Output Only] Server-defined URL for the resource. 597 * </pre> 598 * 599 * <code>optional string self_link = 456214797;</code> 600 * 601 * @return The bytes for selfLink. 602 */ getSelfLinkBytes()603 com.google.protobuf.ByteString getSelfLinkBytes(); 604 605 /** 606 * 607 * 608 * <pre> 609 * [Output only] Number of network endpoints in the network endpoint group. 610 * </pre> 611 * 612 * <code>optional int32 size = 3530753;</code> 613 * 614 * @return Whether the size field is set. 615 */ hasSize()616 boolean hasSize(); 617 /** 618 * 619 * 620 * <pre> 621 * [Output only] Number of network endpoints in the network endpoint group. 622 * </pre> 623 * 624 * <code>optional int32 size = 3530753;</code> 625 * 626 * @return The size. 627 */ getSize()628 int getSize(); 629 630 /** 631 * 632 * 633 * <pre> 634 * Optional URL of the subnetwork to which all network endpoints in the NEG belong. 635 * </pre> 636 * 637 * <code>optional string subnetwork = 307827694;</code> 638 * 639 * @return Whether the subnetwork field is set. 640 */ hasSubnetwork()641 boolean hasSubnetwork(); 642 /** 643 * 644 * 645 * <pre> 646 * Optional URL of the subnetwork to which all network endpoints in the NEG belong. 647 * </pre> 648 * 649 * <code>optional string subnetwork = 307827694;</code> 650 * 651 * @return The subnetwork. 652 */ getSubnetwork()653 java.lang.String getSubnetwork(); 654 /** 655 * 656 * 657 * <pre> 658 * Optional URL of the subnetwork to which all network endpoints in the NEG belong. 659 * </pre> 660 * 661 * <code>optional string subnetwork = 307827694;</code> 662 * 663 * @return The bytes for subnetwork. 664 */ getSubnetworkBytes()665 com.google.protobuf.ByteString getSubnetworkBytes(); 666 667 /** 668 * 669 * 670 * <pre> 671 * [Output Only] The URL of the zone where the network endpoint group is located. 672 * </pre> 673 * 674 * <code>optional string zone = 3744684;</code> 675 * 676 * @return Whether the zone field is set. 677 */ hasZone()678 boolean hasZone(); 679 /** 680 * 681 * 682 * <pre> 683 * [Output Only] The URL of the zone where the network endpoint group is located. 684 * </pre> 685 * 686 * <code>optional string zone = 3744684;</code> 687 * 688 * @return The zone. 689 */ getZone()690 java.lang.String getZone(); 691 /** 692 * 693 * 694 * <pre> 695 * [Output Only] The URL of the zone where the network endpoint group is located. 696 * </pre> 697 * 698 * <code>optional string zone = 3744684;</code> 699 * 700 * @return The bytes for zone. 701 */ getZoneBytes()702 com.google.protobuf.ByteString getZoneBytes(); 703 } 704