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/functions/v1/functions.proto 18 19 package com.google.cloud.functions.v1; 20 21 public interface CloudFunctionOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.functions.v1.CloudFunction) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * A user-defined name of the function. Function names must be unique 31 * globally and match pattern `projects/*/locations/*/functions/*` 32 * </pre> 33 * 34 * <code>string name = 1;</code> 35 * 36 * @return The name. 37 */ getName()38 java.lang.String getName(); 39 /** 40 * 41 * 42 * <pre> 43 * A user-defined name of the function. Function names must be unique 44 * globally and match pattern `projects/*/locations/*/functions/*` 45 * </pre> 46 * 47 * <code>string name = 1;</code> 48 * 49 * @return The bytes for name. 50 */ getNameBytes()51 com.google.protobuf.ByteString getNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * User-provided description of a function. 58 * </pre> 59 * 60 * <code>string description = 2;</code> 61 * 62 * @return The description. 63 */ getDescription()64 java.lang.String getDescription(); 65 /** 66 * 67 * 68 * <pre> 69 * User-provided description of a function. 70 * </pre> 71 * 72 * <code>string description = 2;</code> 73 * 74 * @return The bytes for description. 75 */ getDescriptionBytes()76 com.google.protobuf.ByteString getDescriptionBytes(); 77 78 /** 79 * 80 * 81 * <pre> 82 * The Google Cloud Storage URL, starting with `gs://`, pointing to the zip 83 * archive which contains the function. 84 * </pre> 85 * 86 * <code>string source_archive_url = 3;</code> 87 * 88 * @return Whether the sourceArchiveUrl field is set. 89 */ hasSourceArchiveUrl()90 boolean hasSourceArchiveUrl(); 91 /** 92 * 93 * 94 * <pre> 95 * The Google Cloud Storage URL, starting with `gs://`, pointing to the zip 96 * archive which contains the function. 97 * </pre> 98 * 99 * <code>string source_archive_url = 3;</code> 100 * 101 * @return The sourceArchiveUrl. 102 */ getSourceArchiveUrl()103 java.lang.String getSourceArchiveUrl(); 104 /** 105 * 106 * 107 * <pre> 108 * The Google Cloud Storage URL, starting with `gs://`, pointing to the zip 109 * archive which contains the function. 110 * </pre> 111 * 112 * <code>string source_archive_url = 3;</code> 113 * 114 * @return The bytes for sourceArchiveUrl. 115 */ getSourceArchiveUrlBytes()116 com.google.protobuf.ByteString getSourceArchiveUrlBytes(); 117 118 /** 119 * 120 * 121 * <pre> 122 * **Beta Feature** 123 * The source repository where a function is hosted. 124 * </pre> 125 * 126 * <code>.google.cloud.functions.v1.SourceRepository source_repository = 4;</code> 127 * 128 * @return Whether the sourceRepository field is set. 129 */ hasSourceRepository()130 boolean hasSourceRepository(); 131 /** 132 * 133 * 134 * <pre> 135 * **Beta Feature** 136 * The source repository where a function is hosted. 137 * </pre> 138 * 139 * <code>.google.cloud.functions.v1.SourceRepository source_repository = 4;</code> 140 * 141 * @return The sourceRepository. 142 */ getSourceRepository()143 com.google.cloud.functions.v1.SourceRepository getSourceRepository(); 144 /** 145 * 146 * 147 * <pre> 148 * **Beta Feature** 149 * The source repository where a function is hosted. 150 * </pre> 151 * 152 * <code>.google.cloud.functions.v1.SourceRepository source_repository = 4;</code> 153 */ getSourceRepositoryOrBuilder()154 com.google.cloud.functions.v1.SourceRepositoryOrBuilder getSourceRepositoryOrBuilder(); 155 156 /** 157 * 158 * 159 * <pre> 160 * The Google Cloud Storage-signed URL used for source uploading, generated 161 * by calling [google.cloud.functions.v1.GenerateUploadUrl]. 162 * The signature is validated on write methods (Create, Update) 163 * The signature is stripped from the Function object on read methods (Get, 164 * List) 165 * </pre> 166 * 167 * <code>string source_upload_url = 16;</code> 168 * 169 * @return Whether the sourceUploadUrl field is set. 170 */ hasSourceUploadUrl()171 boolean hasSourceUploadUrl(); 172 /** 173 * 174 * 175 * <pre> 176 * The Google Cloud Storage-signed URL used for source uploading, generated 177 * by calling [google.cloud.functions.v1.GenerateUploadUrl]. 178 * The signature is validated on write methods (Create, Update) 179 * The signature is stripped from the Function object on read methods (Get, 180 * List) 181 * </pre> 182 * 183 * <code>string source_upload_url = 16;</code> 184 * 185 * @return The sourceUploadUrl. 186 */ getSourceUploadUrl()187 java.lang.String getSourceUploadUrl(); 188 /** 189 * 190 * 191 * <pre> 192 * The Google Cloud Storage-signed URL used for source uploading, generated 193 * by calling [google.cloud.functions.v1.GenerateUploadUrl]. 194 * The signature is validated on write methods (Create, Update) 195 * The signature is stripped from the Function object on read methods (Get, 196 * List) 197 * </pre> 198 * 199 * <code>string source_upload_url = 16;</code> 200 * 201 * @return The bytes for sourceUploadUrl. 202 */ getSourceUploadUrlBytes()203 com.google.protobuf.ByteString getSourceUploadUrlBytes(); 204 205 /** 206 * 207 * 208 * <pre> 209 * An HTTPS endpoint type of source that can be triggered via URL. 210 * </pre> 211 * 212 * <code>.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;</code> 213 * 214 * @return Whether the httpsTrigger field is set. 215 */ hasHttpsTrigger()216 boolean hasHttpsTrigger(); 217 /** 218 * 219 * 220 * <pre> 221 * An HTTPS endpoint type of source that can be triggered via URL. 222 * </pre> 223 * 224 * <code>.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;</code> 225 * 226 * @return The httpsTrigger. 227 */ getHttpsTrigger()228 com.google.cloud.functions.v1.HttpsTrigger getHttpsTrigger(); 229 /** 230 * 231 * 232 * <pre> 233 * An HTTPS endpoint type of source that can be triggered via URL. 234 * </pre> 235 * 236 * <code>.google.cloud.functions.v1.HttpsTrigger https_trigger = 5;</code> 237 */ getHttpsTriggerOrBuilder()238 com.google.cloud.functions.v1.HttpsTriggerOrBuilder getHttpsTriggerOrBuilder(); 239 240 /** 241 * 242 * 243 * <pre> 244 * A source that fires events in response to a condition in another service. 245 * </pre> 246 * 247 * <code>.google.cloud.functions.v1.EventTrigger event_trigger = 6;</code> 248 * 249 * @return Whether the eventTrigger field is set. 250 */ hasEventTrigger()251 boolean hasEventTrigger(); 252 /** 253 * 254 * 255 * <pre> 256 * A source that fires events in response to a condition in another service. 257 * </pre> 258 * 259 * <code>.google.cloud.functions.v1.EventTrigger event_trigger = 6;</code> 260 * 261 * @return The eventTrigger. 262 */ getEventTrigger()263 com.google.cloud.functions.v1.EventTrigger getEventTrigger(); 264 /** 265 * 266 * 267 * <pre> 268 * A source that fires events in response to a condition in another service. 269 * </pre> 270 * 271 * <code>.google.cloud.functions.v1.EventTrigger event_trigger = 6;</code> 272 */ getEventTriggerOrBuilder()273 com.google.cloud.functions.v1.EventTriggerOrBuilder getEventTriggerOrBuilder(); 274 275 /** 276 * 277 * 278 * <pre> 279 * Output only. Status of the function deployment. 280 * </pre> 281 * 282 * <code> 283 * .google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 284 * </code> 285 * 286 * @return The enum numeric value on the wire for status. 287 */ getStatusValue()288 int getStatusValue(); 289 /** 290 * 291 * 292 * <pre> 293 * Output only. Status of the function deployment. 294 * </pre> 295 * 296 * <code> 297 * .google.cloud.functions.v1.CloudFunctionStatus status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 298 * </code> 299 * 300 * @return The status. 301 */ getStatus()302 com.google.cloud.functions.v1.CloudFunctionStatus getStatus(); 303 304 /** 305 * 306 * 307 * <pre> 308 * The name of the function (as defined in source code) that is executed. 309 * Defaults to the resource name suffix, if not specified. For 310 * backward compatibility, if function with given name is not found, the 311 * system tries to use the function named "function". 312 * For Node.js, this is the name of a function exported by the module 313 * as specified in `source_location`. 314 * </pre> 315 * 316 * <code>string entry_point = 8;</code> 317 * 318 * @return The entryPoint. 319 */ getEntryPoint()320 java.lang.String getEntryPoint(); 321 /** 322 * 323 * 324 * <pre> 325 * The name of the function (as defined in source code) that is executed. 326 * Defaults to the resource name suffix, if not specified. For 327 * backward compatibility, if function with given name is not found, the 328 * system tries to use the function named "function". 329 * For Node.js, this is the name of a function exported by the module 330 * as specified in `source_location`. 331 * </pre> 332 * 333 * <code>string entry_point = 8;</code> 334 * 335 * @return The bytes for entryPoint. 336 */ getEntryPointBytes()337 com.google.protobuf.ByteString getEntryPointBytes(); 338 339 /** 340 * 341 * 342 * <pre> 343 * The runtime in which to run the function. Required when deploying a new 344 * function, optional when updating an existing function. For a complete 345 * list of possible choices, see the 346 * [`gcloud` command 347 * reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime). 348 * </pre> 349 * 350 * <code>string runtime = 19;</code> 351 * 352 * @return The runtime. 353 */ getRuntime()354 java.lang.String getRuntime(); 355 /** 356 * 357 * 358 * <pre> 359 * The runtime in which to run the function. Required when deploying a new 360 * function, optional when updating an existing function. For a complete 361 * list of possible choices, see the 362 * [`gcloud` command 363 * reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime). 364 * </pre> 365 * 366 * <code>string runtime = 19;</code> 367 * 368 * @return The bytes for runtime. 369 */ getRuntimeBytes()370 com.google.protobuf.ByteString getRuntimeBytes(); 371 372 /** 373 * 374 * 375 * <pre> 376 * The function execution timeout. Execution is considered failed and 377 * can be terminated if the function is not completed at the end of the 378 * timeout period. Defaults to 60 seconds. 379 * </pre> 380 * 381 * <code>.google.protobuf.Duration timeout = 9;</code> 382 * 383 * @return Whether the timeout field is set. 384 */ hasTimeout()385 boolean hasTimeout(); 386 /** 387 * 388 * 389 * <pre> 390 * The function execution timeout. Execution is considered failed and 391 * can be terminated if the function is not completed at the end of the 392 * timeout period. Defaults to 60 seconds. 393 * </pre> 394 * 395 * <code>.google.protobuf.Duration timeout = 9;</code> 396 * 397 * @return The timeout. 398 */ getTimeout()399 com.google.protobuf.Duration getTimeout(); 400 /** 401 * 402 * 403 * <pre> 404 * The function execution timeout. Execution is considered failed and 405 * can be terminated if the function is not completed at the end of the 406 * timeout period. Defaults to 60 seconds. 407 * </pre> 408 * 409 * <code>.google.protobuf.Duration timeout = 9;</code> 410 */ getTimeoutOrBuilder()411 com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder(); 412 413 /** 414 * 415 * 416 * <pre> 417 * The amount of memory in MB available for a function. 418 * Defaults to 256MB. 419 * </pre> 420 * 421 * <code>int32 available_memory_mb = 10;</code> 422 * 423 * @return The availableMemoryMb. 424 */ getAvailableMemoryMb()425 int getAvailableMemoryMb(); 426 427 /** 428 * 429 * 430 * <pre> 431 * The email of the function's service account. If empty, defaults to 432 * `{project_id}@appspot.gserviceaccount.com`. 433 * </pre> 434 * 435 * <code>string service_account_email = 11;</code> 436 * 437 * @return The serviceAccountEmail. 438 */ getServiceAccountEmail()439 java.lang.String getServiceAccountEmail(); 440 /** 441 * 442 * 443 * <pre> 444 * The email of the function's service account. If empty, defaults to 445 * `{project_id}@appspot.gserviceaccount.com`. 446 * </pre> 447 * 448 * <code>string service_account_email = 11;</code> 449 * 450 * @return The bytes for serviceAccountEmail. 451 */ getServiceAccountEmailBytes()452 com.google.protobuf.ByteString getServiceAccountEmailBytes(); 453 454 /** 455 * 456 * 457 * <pre> 458 * Output only. The last update timestamp of a Cloud Function. 459 * </pre> 460 * 461 * <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 462 * </code> 463 * 464 * @return Whether the updateTime field is set. 465 */ hasUpdateTime()466 boolean hasUpdateTime(); 467 /** 468 * 469 * 470 * <pre> 471 * Output only. The last update timestamp of a Cloud Function. 472 * </pre> 473 * 474 * <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 475 * </code> 476 * 477 * @return The updateTime. 478 */ getUpdateTime()479 com.google.protobuf.Timestamp getUpdateTime(); 480 /** 481 * 482 * 483 * <pre> 484 * Output only. The last update timestamp of a Cloud Function. 485 * </pre> 486 * 487 * <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 488 * </code> 489 */ getUpdateTimeOrBuilder()490 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 491 492 /** 493 * 494 * 495 * <pre> 496 * Output only. The version identifier of the Cloud Function. Each deployment 497 * attempt results in a new version of a function being created. 498 * </pre> 499 * 500 * <code>int64 version_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 501 * 502 * @return The versionId. 503 */ getVersionId()504 long getVersionId(); 505 506 /** 507 * 508 * 509 * <pre> 510 * Labels associated with this Cloud Function. 511 * </pre> 512 * 513 * <code>map<string, string> labels = 15;</code> 514 */ getLabelsCount()515 int getLabelsCount(); 516 /** 517 * 518 * 519 * <pre> 520 * Labels associated with this Cloud Function. 521 * </pre> 522 * 523 * <code>map<string, string> labels = 15;</code> 524 */ containsLabels(java.lang.String key)525 boolean containsLabels(java.lang.String key); 526 /** Use {@link #getLabelsMap()} instead. */ 527 @java.lang.Deprecated getLabels()528 java.util.Map<java.lang.String, java.lang.String> getLabels(); 529 /** 530 * 531 * 532 * <pre> 533 * Labels associated with this Cloud Function. 534 * </pre> 535 * 536 * <code>map<string, string> labels = 15;</code> 537 */ getLabelsMap()538 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 539 /** 540 * 541 * 542 * <pre> 543 * Labels associated with this Cloud Function. 544 * </pre> 545 * 546 * <code>map<string, string> labels = 15;</code> 547 */ 548 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)549 java.lang.String getLabelsOrDefault( 550 java.lang.String key, 551 /* nullable */ 552 java.lang.String defaultValue); 553 /** 554 * 555 * 556 * <pre> 557 * Labels associated with this Cloud Function. 558 * </pre> 559 * 560 * <code>map<string, string> labels = 15;</code> 561 */ getLabelsOrThrow(java.lang.String key)562 java.lang.String getLabelsOrThrow(java.lang.String key); 563 564 /** 565 * 566 * 567 * <pre> 568 * Environment variables that shall be available during function execution. 569 * </pre> 570 * 571 * <code>map<string, string> environment_variables = 17;</code> 572 */ getEnvironmentVariablesCount()573 int getEnvironmentVariablesCount(); 574 /** 575 * 576 * 577 * <pre> 578 * Environment variables that shall be available during function execution. 579 * </pre> 580 * 581 * <code>map<string, string> environment_variables = 17;</code> 582 */ containsEnvironmentVariables(java.lang.String key)583 boolean containsEnvironmentVariables(java.lang.String key); 584 /** Use {@link #getEnvironmentVariablesMap()} instead. */ 585 @java.lang.Deprecated getEnvironmentVariables()586 java.util.Map<java.lang.String, java.lang.String> getEnvironmentVariables(); 587 /** 588 * 589 * 590 * <pre> 591 * Environment variables that shall be available during function execution. 592 * </pre> 593 * 594 * <code>map<string, string> environment_variables = 17;</code> 595 */ getEnvironmentVariablesMap()596 java.util.Map<java.lang.String, java.lang.String> getEnvironmentVariablesMap(); 597 /** 598 * 599 * 600 * <pre> 601 * Environment variables that shall be available during function execution. 602 * </pre> 603 * 604 * <code>map<string, string> environment_variables = 17;</code> 605 */ 606 /* nullable */ getEnvironmentVariablesOrDefault( java.lang.String key, java.lang.String defaultValue)607 java.lang.String getEnvironmentVariablesOrDefault( 608 java.lang.String key, 609 /* nullable */ 610 java.lang.String defaultValue); 611 /** 612 * 613 * 614 * <pre> 615 * Environment variables that shall be available during function execution. 616 * </pre> 617 * 618 * <code>map<string, string> environment_variables = 17;</code> 619 */ getEnvironmentVariablesOrThrow(java.lang.String key)620 java.lang.String getEnvironmentVariablesOrThrow(java.lang.String key); 621 622 /** 623 * 624 * 625 * <pre> 626 * Build environment variables that shall be available during build time. 627 * </pre> 628 * 629 * <code>map<string, string> build_environment_variables = 28;</code> 630 */ getBuildEnvironmentVariablesCount()631 int getBuildEnvironmentVariablesCount(); 632 /** 633 * 634 * 635 * <pre> 636 * Build environment variables that shall be available during build time. 637 * </pre> 638 * 639 * <code>map<string, string> build_environment_variables = 28;</code> 640 */ containsBuildEnvironmentVariables(java.lang.String key)641 boolean containsBuildEnvironmentVariables(java.lang.String key); 642 /** Use {@link #getBuildEnvironmentVariablesMap()} instead. */ 643 @java.lang.Deprecated getBuildEnvironmentVariables()644 java.util.Map<java.lang.String, java.lang.String> getBuildEnvironmentVariables(); 645 /** 646 * 647 * 648 * <pre> 649 * Build environment variables that shall be available during build time. 650 * </pre> 651 * 652 * <code>map<string, string> build_environment_variables = 28;</code> 653 */ getBuildEnvironmentVariablesMap()654 java.util.Map<java.lang.String, java.lang.String> getBuildEnvironmentVariablesMap(); 655 /** 656 * 657 * 658 * <pre> 659 * Build environment variables that shall be available during build time. 660 * </pre> 661 * 662 * <code>map<string, string> build_environment_variables = 28;</code> 663 */ 664 /* nullable */ getBuildEnvironmentVariablesOrDefault( java.lang.String key, java.lang.String defaultValue)665 java.lang.String getBuildEnvironmentVariablesOrDefault( 666 java.lang.String key, 667 /* nullable */ 668 java.lang.String defaultValue); 669 /** 670 * 671 * 672 * <pre> 673 * Build environment variables that shall be available during build time. 674 * </pre> 675 * 676 * <code>map<string, string> build_environment_variables = 28;</code> 677 */ getBuildEnvironmentVariablesOrThrow(java.lang.String key)678 java.lang.String getBuildEnvironmentVariablesOrThrow(java.lang.String key); 679 680 /** 681 * 682 * 683 * <pre> 684 * The Serverless VPC Access connector that this cloud function can connect 685 * to. It can be either the fully qualified URI, or the short name of the 686 * connector resource. If the connector name is used, the connector must 687 * belong to the same project as the function. Otherwise, it must belong to a 688 * project within the same organization. The format of this field is either 689 * `projects/{project}/global/networks/{network}` or `{network}`, where 690 * `{project}` is a project id where the network is defined, and `{network}` 691 * is the short name of the network. 692 * This field is mutually exclusive with `vpc_connector` and will be replaced 693 * by it. 694 * See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 695 * more information on connecting Cloud projects. 696 * </pre> 697 * 698 * <code>string network = 18;</code> 699 * 700 * @return The network. 701 */ getNetwork()702 java.lang.String getNetwork(); 703 /** 704 * 705 * 706 * <pre> 707 * The Serverless VPC Access connector that this cloud function can connect 708 * to. It can be either the fully qualified URI, or the short name of the 709 * connector resource. If the connector name is used, the connector must 710 * belong to the same project as the function. Otherwise, it must belong to a 711 * project within the same organization. The format of this field is either 712 * `projects/{project}/global/networks/{network}` or `{network}`, where 713 * `{project}` is a project id where the network is defined, and `{network}` 714 * is the short name of the network. 715 * This field is mutually exclusive with `vpc_connector` and will be replaced 716 * by it. 717 * See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 718 * more information on connecting Cloud projects. 719 * </pre> 720 * 721 * <code>string network = 18;</code> 722 * 723 * @return The bytes for network. 724 */ getNetworkBytes()725 com.google.protobuf.ByteString getNetworkBytes(); 726 727 /** 728 * 729 * 730 * <pre> 731 * The limit on the maximum number of function instances that can coexist at a 732 * given time. 733 * In some cases, such as rapid traffic surges, Cloud Functions can for a 734 * short period of time create more instances than the specified max 735 * instances limit. If your function cannot tolerate this temporary behavior, 736 * you might want to factor in a safety margin and set a lower max instances 737 * value than your function can tolerate. 738 * See the [Max 739 * Instances](https://cloud.google.com/functions/docs/max-instances) Guide for 740 * more details. 741 * </pre> 742 * 743 * <code>int32 max_instances = 20;</code> 744 * 745 * @return The maxInstances. 746 */ getMaxInstances()747 int getMaxInstances(); 748 749 /** 750 * 751 * 752 * <pre> 753 * A lower bound for the number function instances that can coexist at a 754 * given time. 755 * </pre> 756 * 757 * <code>int32 min_instances = 32;</code> 758 * 759 * @return The minInstances. 760 */ getMinInstances()761 int getMinInstances(); 762 763 /** 764 * 765 * 766 * <pre> 767 * The VPC Network Connector that this cloud function can connect to. It can 768 * be either the fully qualified URI, or the short name of the network 769 * connector resource. The format of this field is 770 * `projects/*/locations/*/connectors/*` 771 * This field is mutually exclusive with `network` field and will eventually 772 * replace it. 773 * See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 774 * more information on connecting Cloud projects. 775 * </pre> 776 * 777 * <code>string vpc_connector = 22;</code> 778 * 779 * @return The vpcConnector. 780 */ getVpcConnector()781 java.lang.String getVpcConnector(); 782 /** 783 * 784 * 785 * <pre> 786 * The VPC Network Connector that this cloud function can connect to. It can 787 * be either the fully qualified URI, or the short name of the network 788 * connector resource. The format of this field is 789 * `projects/*/locations/*/connectors/*` 790 * This field is mutually exclusive with `network` field and will eventually 791 * replace it. 792 * See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for 793 * more information on connecting Cloud projects. 794 * </pre> 795 * 796 * <code>string vpc_connector = 22;</code> 797 * 798 * @return The bytes for vpcConnector. 799 */ getVpcConnectorBytes()800 com.google.protobuf.ByteString getVpcConnectorBytes(); 801 802 /** 803 * 804 * 805 * <pre> 806 * The egress settings for the connector, controlling what traffic is diverted 807 * through it. 808 * </pre> 809 * 810 * <code> 811 * .google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings vpc_connector_egress_settings = 23; 812 * </code> 813 * 814 * @return The enum numeric value on the wire for vpcConnectorEgressSettings. 815 */ getVpcConnectorEgressSettingsValue()816 int getVpcConnectorEgressSettingsValue(); 817 /** 818 * 819 * 820 * <pre> 821 * The egress settings for the connector, controlling what traffic is diverted 822 * through it. 823 * </pre> 824 * 825 * <code> 826 * .google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings vpc_connector_egress_settings = 23; 827 * </code> 828 * 829 * @return The vpcConnectorEgressSettings. 830 */ 831 com.google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings getVpcConnectorEgressSettings()832 getVpcConnectorEgressSettings(); 833 834 /** 835 * 836 * 837 * <pre> 838 * The ingress settings for the function, controlling what traffic can reach 839 * it. 840 * </pre> 841 * 842 * <code>.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;</code> 843 * 844 * @return The enum numeric value on the wire for ingressSettings. 845 */ getIngressSettingsValue()846 int getIngressSettingsValue(); 847 /** 848 * 849 * 850 * <pre> 851 * The ingress settings for the function, controlling what traffic can reach 852 * it. 853 * </pre> 854 * 855 * <code>.google.cloud.functions.v1.CloudFunction.IngressSettings ingress_settings = 24;</code> 856 * 857 * @return The ingressSettings. 858 */ getIngressSettings()859 com.google.cloud.functions.v1.CloudFunction.IngressSettings getIngressSettings(); 860 861 /** 862 * 863 * 864 * <pre> 865 * Resource name of a KMS crypto key (managed by the user) used to 866 * encrypt/decrypt function resources. 867 * It must match the pattern 868 * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. 869 * If specified, you must also provide an artifact registry repository using 870 * the `docker_repository` field that was created with the same KMS crypto 871 * key. 872 * The following service accounts need to be granted the role 'Cloud KMS 873 * CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' 874 * on the Key/KeyRing/Project/Organization (least access preferred). 875 * 1. Google Cloud Functions service account 876 * (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - 877 * Required to protect the function's image. 878 * 2. Google Storage service account 879 * (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - 880 * Required to protect the function's source code. 881 * If this service account does not exist, deploying a function without a 882 * KMS key or retrieving the service agent name provisions it. For more 883 * information, see 884 * https://cloud.google.com/storage/docs/projects#service-agents and 885 * https://cloud.google.com/storage/docs/getting-service-agent#gsutil. 886 * Google Cloud Functions delegates access to service agents to protect 887 * function resources in internal projects that are not accessible by the 888 * end user. 889 * </pre> 890 * 891 * <code>string kms_key_name = 25 [(.google.api.resource_reference) = { ... }</code> 892 * 893 * @return The kmsKeyName. 894 */ getKmsKeyName()895 java.lang.String getKmsKeyName(); 896 /** 897 * 898 * 899 * <pre> 900 * Resource name of a KMS crypto key (managed by the user) used to 901 * encrypt/decrypt function resources. 902 * It must match the pattern 903 * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. 904 * If specified, you must also provide an artifact registry repository using 905 * the `docker_repository` field that was created with the same KMS crypto 906 * key. 907 * The following service accounts need to be granted the role 'Cloud KMS 908 * CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' 909 * on the Key/KeyRing/Project/Organization (least access preferred). 910 * 1. Google Cloud Functions service account 911 * (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - 912 * Required to protect the function's image. 913 * 2. Google Storage service account 914 * (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - 915 * Required to protect the function's source code. 916 * If this service account does not exist, deploying a function without a 917 * KMS key or retrieving the service agent name provisions it. For more 918 * information, see 919 * https://cloud.google.com/storage/docs/projects#service-agents and 920 * https://cloud.google.com/storage/docs/getting-service-agent#gsutil. 921 * Google Cloud Functions delegates access to service agents to protect 922 * function resources in internal projects that are not accessible by the 923 * end user. 924 * </pre> 925 * 926 * <code>string kms_key_name = 25 [(.google.api.resource_reference) = { ... }</code> 927 * 928 * @return The bytes for kmsKeyName. 929 */ getKmsKeyNameBytes()930 com.google.protobuf.ByteString getKmsKeyNameBytes(); 931 932 /** 933 * 934 * 935 * <pre> 936 * Name of the Cloud Build Custom Worker Pool that should be used to build the 937 * function. The format of this field is 938 * `projects/{project}/locations/{region}/workerPools/{workerPool}` where 939 * `{project}` and `{region}` are the project id and region respectively where 940 * the worker pool is defined and `{workerPool}` is the short name of the 941 * worker pool. 942 * If the project id is not the same as the function, then the Cloud 943 * Functions Service Agent 944 * (`service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com`) must 945 * be granted the role Cloud Build Custom Workers Builder 946 * (`roles/cloudbuild.customworkers.builder`) in the project. 947 * </pre> 948 * 949 * <code>string build_worker_pool = 26;</code> 950 * 951 * @return The buildWorkerPool. 952 */ getBuildWorkerPool()953 java.lang.String getBuildWorkerPool(); 954 /** 955 * 956 * 957 * <pre> 958 * Name of the Cloud Build Custom Worker Pool that should be used to build the 959 * function. The format of this field is 960 * `projects/{project}/locations/{region}/workerPools/{workerPool}` where 961 * `{project}` and `{region}` are the project id and region respectively where 962 * the worker pool is defined and `{workerPool}` is the short name of the 963 * worker pool. 964 * If the project id is not the same as the function, then the Cloud 965 * Functions Service Agent 966 * (`service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com`) must 967 * be granted the role Cloud Build Custom Workers Builder 968 * (`roles/cloudbuild.customworkers.builder`) in the project. 969 * </pre> 970 * 971 * <code>string build_worker_pool = 26;</code> 972 * 973 * @return The bytes for buildWorkerPool. 974 */ getBuildWorkerPoolBytes()975 com.google.protobuf.ByteString getBuildWorkerPoolBytes(); 976 977 /** 978 * 979 * 980 * <pre> 981 * Output only. The Cloud Build ID of the latest successful deployment of the 982 * function. 983 * </pre> 984 * 985 * <code>string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 986 * 987 * @return The buildId. 988 */ getBuildId()989 java.lang.String getBuildId(); 990 /** 991 * 992 * 993 * <pre> 994 * Output only. The Cloud Build ID of the latest successful deployment of the 995 * function. 996 * </pre> 997 * 998 * <code>string build_id = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 999 * 1000 * @return The bytes for buildId. 1001 */ getBuildIdBytes()1002 com.google.protobuf.ByteString getBuildIdBytes(); 1003 1004 /** 1005 * 1006 * 1007 * <pre> 1008 * Output only. The Cloud Build Name of the function deployment. 1009 * `projects/<project-number>/locations/<region>/builds/<build-id>`. 1010 * </pre> 1011 * 1012 * <code>string build_name = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 1013 * 1014 * @return The buildName. 1015 */ getBuildName()1016 java.lang.String getBuildName(); 1017 /** 1018 * 1019 * 1020 * <pre> 1021 * Output only. The Cloud Build Name of the function deployment. 1022 * `projects/<project-number>/locations/<region>/builds/<build-id>`. 1023 * </pre> 1024 * 1025 * <code>string build_name = 33 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 1026 * 1027 * @return The bytes for buildName. 1028 */ getBuildNameBytes()1029 com.google.protobuf.ByteString getBuildNameBytes(); 1030 1031 /** 1032 * 1033 * 1034 * <pre> 1035 * Secret environment variables configuration. 1036 * </pre> 1037 * 1038 * <code>repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29; 1039 * </code> 1040 */ getSecretEnvironmentVariablesList()1041 java.util.List<com.google.cloud.functions.v1.SecretEnvVar> getSecretEnvironmentVariablesList(); 1042 /** 1043 * 1044 * 1045 * <pre> 1046 * Secret environment variables configuration. 1047 * </pre> 1048 * 1049 * <code>repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29; 1050 * </code> 1051 */ getSecretEnvironmentVariables(int index)1052 com.google.cloud.functions.v1.SecretEnvVar getSecretEnvironmentVariables(int index); 1053 /** 1054 * 1055 * 1056 * <pre> 1057 * Secret environment variables configuration. 1058 * </pre> 1059 * 1060 * <code>repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29; 1061 * </code> 1062 */ getSecretEnvironmentVariablesCount()1063 int getSecretEnvironmentVariablesCount(); 1064 /** 1065 * 1066 * 1067 * <pre> 1068 * Secret environment variables configuration. 1069 * </pre> 1070 * 1071 * <code>repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29; 1072 * </code> 1073 */ 1074 java.util.List<? extends com.google.cloud.functions.v1.SecretEnvVarOrBuilder> getSecretEnvironmentVariablesOrBuilderList()1075 getSecretEnvironmentVariablesOrBuilderList(); 1076 /** 1077 * 1078 * 1079 * <pre> 1080 * Secret environment variables configuration. 1081 * </pre> 1082 * 1083 * <code>repeated .google.cloud.functions.v1.SecretEnvVar secret_environment_variables = 29; 1084 * </code> 1085 */ getSecretEnvironmentVariablesOrBuilder( int index)1086 com.google.cloud.functions.v1.SecretEnvVarOrBuilder getSecretEnvironmentVariablesOrBuilder( 1087 int index); 1088 1089 /** 1090 * 1091 * 1092 * <pre> 1093 * Secret volumes configuration. 1094 * </pre> 1095 * 1096 * <code>repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;</code> 1097 */ getSecretVolumesList()1098 java.util.List<com.google.cloud.functions.v1.SecretVolume> getSecretVolumesList(); 1099 /** 1100 * 1101 * 1102 * <pre> 1103 * Secret volumes configuration. 1104 * </pre> 1105 * 1106 * <code>repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;</code> 1107 */ getSecretVolumes(int index)1108 com.google.cloud.functions.v1.SecretVolume getSecretVolumes(int index); 1109 /** 1110 * 1111 * 1112 * <pre> 1113 * Secret volumes configuration. 1114 * </pre> 1115 * 1116 * <code>repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;</code> 1117 */ getSecretVolumesCount()1118 int getSecretVolumesCount(); 1119 /** 1120 * 1121 * 1122 * <pre> 1123 * Secret volumes configuration. 1124 * </pre> 1125 * 1126 * <code>repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;</code> 1127 */ 1128 java.util.List<? extends com.google.cloud.functions.v1.SecretVolumeOrBuilder> getSecretVolumesOrBuilderList()1129 getSecretVolumesOrBuilderList(); 1130 /** 1131 * 1132 * 1133 * <pre> 1134 * Secret volumes configuration. 1135 * </pre> 1136 * 1137 * <code>repeated .google.cloud.functions.v1.SecretVolume secret_volumes = 30;</code> 1138 */ getSecretVolumesOrBuilder(int index)1139 com.google.cloud.functions.v1.SecretVolumeOrBuilder getSecretVolumesOrBuilder(int index); 1140 1141 /** 1142 * 1143 * 1144 * <pre> 1145 * Input only. An identifier for Firebase function sources. Disclaimer: This 1146 * field is only supported for Firebase function deployments. 1147 * </pre> 1148 * 1149 * <code>string source_token = 31 [(.google.api.field_behavior) = INPUT_ONLY];</code> 1150 * 1151 * @return The sourceToken. 1152 */ getSourceToken()1153 java.lang.String getSourceToken(); 1154 /** 1155 * 1156 * 1157 * <pre> 1158 * Input only. An identifier for Firebase function sources. Disclaimer: This 1159 * field is only supported for Firebase function deployments. 1160 * </pre> 1161 * 1162 * <code>string source_token = 31 [(.google.api.field_behavior) = INPUT_ONLY];</code> 1163 * 1164 * @return The bytes for sourceToken. 1165 */ getSourceTokenBytes()1166 com.google.protobuf.ByteString getSourceTokenBytes(); 1167 1168 /** 1169 * 1170 * 1171 * <pre> 1172 * User managed repository created in Artifact Registry optionally with a 1173 * customer managed encryption key. If specified, deployments will use 1174 * Artifact Registry. If unspecified and the deployment is eligible to use 1175 * Artifact Registry, GCF will create and use a repository named 1176 * 'gcf-artifacts' for every deployed region. This is the repository to which 1177 * the function docker image is pushed after it is built by Cloud Build. 1178 * It must match the pattern 1179 * `projects/{project}/locations/{location}/repositories/{repository}`. 1180 * Cross-project repositories are not supported. 1181 * Cross-location repositories are not supported. 1182 * Repository format must be 'DOCKER'. 1183 * </pre> 1184 * 1185 * <code>string docker_repository = 34 [(.google.api.resource_reference) = { ... }</code> 1186 * 1187 * @return The dockerRepository. 1188 */ getDockerRepository()1189 java.lang.String getDockerRepository(); 1190 /** 1191 * 1192 * 1193 * <pre> 1194 * User managed repository created in Artifact Registry optionally with a 1195 * customer managed encryption key. If specified, deployments will use 1196 * Artifact Registry. If unspecified and the deployment is eligible to use 1197 * Artifact Registry, GCF will create and use a repository named 1198 * 'gcf-artifacts' for every deployed region. This is the repository to which 1199 * the function docker image is pushed after it is built by Cloud Build. 1200 * It must match the pattern 1201 * `projects/{project}/locations/{location}/repositories/{repository}`. 1202 * Cross-project repositories are not supported. 1203 * Cross-location repositories are not supported. 1204 * Repository format must be 'DOCKER'. 1205 * </pre> 1206 * 1207 * <code>string docker_repository = 34 [(.google.api.resource_reference) = { ... }</code> 1208 * 1209 * @return The bytes for dockerRepository. 1210 */ getDockerRepositoryBytes()1211 com.google.protobuf.ByteString getDockerRepositoryBytes(); 1212 1213 /** 1214 * 1215 * 1216 * <pre> 1217 * Docker Registry to use for this deployment. 1218 * If `docker_repository` field is specified, this field is automatically 1219 * set as `ARTIFACT_REGISTRY`. 1220 * If unspecified, it currently defaults to `CONTAINER_REGISTRY`. 1221 * This field may be overridden by the backend for eligible deployments. 1222 * </pre> 1223 * 1224 * <code>.google.cloud.functions.v1.CloudFunction.DockerRegistry docker_registry = 35;</code> 1225 * 1226 * @return The enum numeric value on the wire for dockerRegistry. 1227 */ getDockerRegistryValue()1228 int getDockerRegistryValue(); 1229 /** 1230 * 1231 * 1232 * <pre> 1233 * Docker Registry to use for this deployment. 1234 * If `docker_repository` field is specified, this field is automatically 1235 * set as `ARTIFACT_REGISTRY`. 1236 * If unspecified, it currently defaults to `CONTAINER_REGISTRY`. 1237 * This field may be overridden by the backend for eligible deployments. 1238 * </pre> 1239 * 1240 * <code>.google.cloud.functions.v1.CloudFunction.DockerRegistry docker_registry = 35;</code> 1241 * 1242 * @return The dockerRegistry. 1243 */ getDockerRegistry()1244 com.google.cloud.functions.v1.CloudFunction.DockerRegistry getDockerRegistry(); 1245 getSourceCodeCase()1246 public com.google.cloud.functions.v1.CloudFunction.SourceCodeCase getSourceCodeCase(); 1247 getTriggerCase()1248 public com.google.cloud.functions.v1.CloudFunction.TriggerCase getTriggerCase(); 1249 } 1250