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/devtools/cloudbuild/v1/cloudbuild.proto 18 19 package com.google.cloudbuild.v1; 20 21 public interface BuildStepOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.devtools.cloudbuild.v1.BuildStep) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The name of the container image that will run this particular 31 * build step. 32 * If the image is available in the host's Docker daemon's cache, it 33 * will be run directly. If not, the host will attempt to pull the image 34 * first, using the builder service account's credentials if necessary. 35 * The Docker daemon's cache will already have the latest versions of all of 36 * the officially supported build steps 37 * ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). 38 * The Docker daemon will also have cached many of the layers for some popular 39 * images, like "ubuntu", "debian", but they will be refreshed at the time you 40 * attempt to use them. 41 * If you built an image in a previous build step, it will be stored in the 42 * host's Docker daemon's cache and is available to use as the name for a 43 * later build step. 44 * </pre> 45 * 46 * <code>string name = 1;</code> 47 * 48 * @return The name. 49 */ getName()50 java.lang.String getName(); 51 /** 52 * 53 * 54 * <pre> 55 * Required. The name of the container image that will run this particular 56 * build step. 57 * If the image is available in the host's Docker daemon's cache, it 58 * will be run directly. If not, the host will attempt to pull the image 59 * first, using the builder service account's credentials if necessary. 60 * The Docker daemon's cache will already have the latest versions of all of 61 * the officially supported build steps 62 * ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). 63 * The Docker daemon will also have cached many of the layers for some popular 64 * images, like "ubuntu", "debian", but they will be refreshed at the time you 65 * attempt to use them. 66 * If you built an image in a previous build step, it will be stored in the 67 * host's Docker daemon's cache and is available to use as the name for a 68 * later build step. 69 * </pre> 70 * 71 * <code>string name = 1;</code> 72 * 73 * @return The bytes for name. 74 */ getNameBytes()75 com.google.protobuf.ByteString getNameBytes(); 76 77 /** 78 * 79 * 80 * <pre> 81 * A list of environment variable definitions to be used when running a step. 82 * The elements are of the form "KEY=VALUE" for the environment variable "KEY" 83 * being given the value "VALUE". 84 * </pre> 85 * 86 * <code>repeated string env = 2;</code> 87 * 88 * @return A list containing the env. 89 */ getEnvList()90 java.util.List<java.lang.String> getEnvList(); 91 /** 92 * 93 * 94 * <pre> 95 * A list of environment variable definitions to be used when running a step. 96 * The elements are of the form "KEY=VALUE" for the environment variable "KEY" 97 * being given the value "VALUE". 98 * </pre> 99 * 100 * <code>repeated string env = 2;</code> 101 * 102 * @return The count of env. 103 */ getEnvCount()104 int getEnvCount(); 105 /** 106 * 107 * 108 * <pre> 109 * A list of environment variable definitions to be used when running a step. 110 * The elements are of the form "KEY=VALUE" for the environment variable "KEY" 111 * being given the value "VALUE". 112 * </pre> 113 * 114 * <code>repeated string env = 2;</code> 115 * 116 * @param index The index of the element to return. 117 * @return The env at the given index. 118 */ getEnv(int index)119 java.lang.String getEnv(int index); 120 /** 121 * 122 * 123 * <pre> 124 * A list of environment variable definitions to be used when running a step. 125 * The elements are of the form "KEY=VALUE" for the environment variable "KEY" 126 * being given the value "VALUE". 127 * </pre> 128 * 129 * <code>repeated string env = 2;</code> 130 * 131 * @param index The index of the value to return. 132 * @return The bytes of the env at the given index. 133 */ getEnvBytes(int index)134 com.google.protobuf.ByteString getEnvBytes(int index); 135 136 /** 137 * 138 * 139 * <pre> 140 * A list of arguments that will be presented to the step when it is started. 141 * If the image used to run the step's container has an entrypoint, the `args` 142 * are used as arguments to that entrypoint. If the image does not define 143 * an entrypoint, the first element in args is used as the entrypoint, 144 * and the remainder will be used as arguments. 145 * </pre> 146 * 147 * <code>repeated string args = 3;</code> 148 * 149 * @return A list containing the args. 150 */ getArgsList()151 java.util.List<java.lang.String> getArgsList(); 152 /** 153 * 154 * 155 * <pre> 156 * A list of arguments that will be presented to the step when it is started. 157 * If the image used to run the step's container has an entrypoint, the `args` 158 * are used as arguments to that entrypoint. If the image does not define 159 * an entrypoint, the first element in args is used as the entrypoint, 160 * and the remainder will be used as arguments. 161 * </pre> 162 * 163 * <code>repeated string args = 3;</code> 164 * 165 * @return The count of args. 166 */ getArgsCount()167 int getArgsCount(); 168 /** 169 * 170 * 171 * <pre> 172 * A list of arguments that will be presented to the step when it is started. 173 * If the image used to run the step's container has an entrypoint, the `args` 174 * are used as arguments to that entrypoint. If the image does not define 175 * an entrypoint, the first element in args is used as the entrypoint, 176 * and the remainder will be used as arguments. 177 * </pre> 178 * 179 * <code>repeated string args = 3;</code> 180 * 181 * @param index The index of the element to return. 182 * @return The args at the given index. 183 */ getArgs(int index)184 java.lang.String getArgs(int index); 185 /** 186 * 187 * 188 * <pre> 189 * A list of arguments that will be presented to the step when it is started. 190 * If the image used to run the step's container has an entrypoint, the `args` 191 * are used as arguments to that entrypoint. If the image does not define 192 * an entrypoint, the first element in args is used as the entrypoint, 193 * and the remainder will be used as arguments. 194 * </pre> 195 * 196 * <code>repeated string args = 3;</code> 197 * 198 * @param index The index of the value to return. 199 * @return The bytes of the args at the given index. 200 */ getArgsBytes(int index)201 com.google.protobuf.ByteString getArgsBytes(int index); 202 203 /** 204 * 205 * 206 * <pre> 207 * Working directory to use when running this step's container. 208 * If this value is a relative path, it is relative to the build's working 209 * directory. If this value is absolute, it may be outside the build's working 210 * directory, in which case the contents of the path may not be persisted 211 * across build step executions, unless a `volume` for that path is specified. 212 * If the build specifies a `RepoSource` with `dir` and a step with a `dir`, 213 * which specifies an absolute path, the `RepoSource` `dir` is ignored for 214 * the step's execution. 215 * </pre> 216 * 217 * <code>string dir = 4;</code> 218 * 219 * @return The dir. 220 */ getDir()221 java.lang.String getDir(); 222 /** 223 * 224 * 225 * <pre> 226 * Working directory to use when running this step's container. 227 * If this value is a relative path, it is relative to the build's working 228 * directory. If this value is absolute, it may be outside the build's working 229 * directory, in which case the contents of the path may not be persisted 230 * across build step executions, unless a `volume` for that path is specified. 231 * If the build specifies a `RepoSource` with `dir` and a step with a `dir`, 232 * which specifies an absolute path, the `RepoSource` `dir` is ignored for 233 * the step's execution. 234 * </pre> 235 * 236 * <code>string dir = 4;</code> 237 * 238 * @return The bytes for dir. 239 */ getDirBytes()240 com.google.protobuf.ByteString getDirBytes(); 241 242 /** 243 * 244 * 245 * <pre> 246 * Unique identifier for this build step, used in `wait_for` to 247 * reference this build step as a dependency. 248 * </pre> 249 * 250 * <code>string id = 5;</code> 251 * 252 * @return The id. 253 */ getId()254 java.lang.String getId(); 255 /** 256 * 257 * 258 * <pre> 259 * Unique identifier for this build step, used in `wait_for` to 260 * reference this build step as a dependency. 261 * </pre> 262 * 263 * <code>string id = 5;</code> 264 * 265 * @return The bytes for id. 266 */ getIdBytes()267 com.google.protobuf.ByteString getIdBytes(); 268 269 /** 270 * 271 * 272 * <pre> 273 * The ID(s) of the step(s) that this build step depends on. 274 * This build step will not start until all the build steps in `wait_for` 275 * have completed successfully. If `wait_for` is empty, this build step will 276 * start when all previous build steps in the `Build.Steps` list have 277 * completed successfully. 278 * </pre> 279 * 280 * <code>repeated string wait_for = 6;</code> 281 * 282 * @return A list containing the waitFor. 283 */ getWaitForList()284 java.util.List<java.lang.String> getWaitForList(); 285 /** 286 * 287 * 288 * <pre> 289 * The ID(s) of the step(s) that this build step depends on. 290 * This build step will not start until all the build steps in `wait_for` 291 * have completed successfully. If `wait_for` is empty, this build step will 292 * start when all previous build steps in the `Build.Steps` list have 293 * completed successfully. 294 * </pre> 295 * 296 * <code>repeated string wait_for = 6;</code> 297 * 298 * @return The count of waitFor. 299 */ getWaitForCount()300 int getWaitForCount(); 301 /** 302 * 303 * 304 * <pre> 305 * The ID(s) of the step(s) that this build step depends on. 306 * This build step will not start until all the build steps in `wait_for` 307 * have completed successfully. If `wait_for` is empty, this build step will 308 * start when all previous build steps in the `Build.Steps` list have 309 * completed successfully. 310 * </pre> 311 * 312 * <code>repeated string wait_for = 6;</code> 313 * 314 * @param index The index of the element to return. 315 * @return The waitFor at the given index. 316 */ getWaitFor(int index)317 java.lang.String getWaitFor(int index); 318 /** 319 * 320 * 321 * <pre> 322 * The ID(s) of the step(s) that this build step depends on. 323 * This build step will not start until all the build steps in `wait_for` 324 * have completed successfully. If `wait_for` is empty, this build step will 325 * start when all previous build steps in the `Build.Steps` list have 326 * completed successfully. 327 * </pre> 328 * 329 * <code>repeated string wait_for = 6;</code> 330 * 331 * @param index The index of the value to return. 332 * @return The bytes of the waitFor at the given index. 333 */ getWaitForBytes(int index)334 com.google.protobuf.ByteString getWaitForBytes(int index); 335 336 /** 337 * 338 * 339 * <pre> 340 * Entrypoint to be used instead of the build step image's default entrypoint. 341 * If unset, the image's default entrypoint is used. 342 * </pre> 343 * 344 * <code>string entrypoint = 7;</code> 345 * 346 * @return The entrypoint. 347 */ getEntrypoint()348 java.lang.String getEntrypoint(); 349 /** 350 * 351 * 352 * <pre> 353 * Entrypoint to be used instead of the build step image's default entrypoint. 354 * If unset, the image's default entrypoint is used. 355 * </pre> 356 * 357 * <code>string entrypoint = 7;</code> 358 * 359 * @return The bytes for entrypoint. 360 */ getEntrypointBytes()361 com.google.protobuf.ByteString getEntrypointBytes(); 362 363 /** 364 * 365 * 366 * <pre> 367 * A list of environment variables which are encrypted using a Cloud Key 368 * Management Service crypto key. These values must be specified in the 369 * build's `Secret`. 370 * </pre> 371 * 372 * <code>repeated string secret_env = 8;</code> 373 * 374 * @return A list containing the secretEnv. 375 */ getSecretEnvList()376 java.util.List<java.lang.String> getSecretEnvList(); 377 /** 378 * 379 * 380 * <pre> 381 * A list of environment variables which are encrypted using a Cloud Key 382 * Management Service crypto key. These values must be specified in the 383 * build's `Secret`. 384 * </pre> 385 * 386 * <code>repeated string secret_env = 8;</code> 387 * 388 * @return The count of secretEnv. 389 */ getSecretEnvCount()390 int getSecretEnvCount(); 391 /** 392 * 393 * 394 * <pre> 395 * A list of environment variables which are encrypted using a Cloud Key 396 * Management Service crypto key. These values must be specified in the 397 * build's `Secret`. 398 * </pre> 399 * 400 * <code>repeated string secret_env = 8;</code> 401 * 402 * @param index The index of the element to return. 403 * @return The secretEnv at the given index. 404 */ getSecretEnv(int index)405 java.lang.String getSecretEnv(int index); 406 /** 407 * 408 * 409 * <pre> 410 * A list of environment variables which are encrypted using a Cloud Key 411 * Management Service crypto key. These values must be specified in the 412 * build's `Secret`. 413 * </pre> 414 * 415 * <code>repeated string secret_env = 8;</code> 416 * 417 * @param index The index of the value to return. 418 * @return The bytes of the secretEnv at the given index. 419 */ getSecretEnvBytes(int index)420 com.google.protobuf.ByteString getSecretEnvBytes(int index); 421 422 /** 423 * 424 * 425 * <pre> 426 * List of volumes to mount into the build step. 427 * Each volume is created as an empty volume prior to execution of the 428 * build step. Upon completion of the build, volumes and their contents are 429 * discarded. 430 * Using a named volume in only one step is not valid as it is indicative 431 * of a build request with an incorrect configuration. 432 * </pre> 433 * 434 * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;</code> 435 */ getVolumesList()436 java.util.List<com.google.cloudbuild.v1.Volume> getVolumesList(); 437 /** 438 * 439 * 440 * <pre> 441 * List of volumes to mount into the build step. 442 * Each volume is created as an empty volume prior to execution of the 443 * build step. Upon completion of the build, volumes and their contents are 444 * discarded. 445 * Using a named volume in only one step is not valid as it is indicative 446 * of a build request with an incorrect configuration. 447 * </pre> 448 * 449 * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;</code> 450 */ getVolumes(int index)451 com.google.cloudbuild.v1.Volume getVolumes(int index); 452 /** 453 * 454 * 455 * <pre> 456 * List of volumes to mount into the build step. 457 * Each volume is created as an empty volume prior to execution of the 458 * build step. Upon completion of the build, volumes and their contents are 459 * discarded. 460 * Using a named volume in only one step is not valid as it is indicative 461 * of a build request with an incorrect configuration. 462 * </pre> 463 * 464 * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;</code> 465 */ getVolumesCount()466 int getVolumesCount(); 467 /** 468 * 469 * 470 * <pre> 471 * List of volumes to mount into the build step. 472 * Each volume is created as an empty volume prior to execution of the 473 * build step. Upon completion of the build, volumes and their contents are 474 * discarded. 475 * Using a named volume in only one step is not valid as it is indicative 476 * of a build request with an incorrect configuration. 477 * </pre> 478 * 479 * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;</code> 480 */ getVolumesOrBuilderList()481 java.util.List<? extends com.google.cloudbuild.v1.VolumeOrBuilder> getVolumesOrBuilderList(); 482 /** 483 * 484 * 485 * <pre> 486 * List of volumes to mount into the build step. 487 * Each volume is created as an empty volume prior to execution of the 488 * build step. Upon completion of the build, volumes and their contents are 489 * discarded. 490 * Using a named volume in only one step is not valid as it is indicative 491 * of a build request with an incorrect configuration. 492 * </pre> 493 * 494 * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 9;</code> 495 */ getVolumesOrBuilder(int index)496 com.google.cloudbuild.v1.VolumeOrBuilder getVolumesOrBuilder(int index); 497 498 /** 499 * 500 * 501 * <pre> 502 * Output only. Stores timing information for executing this build step. 503 * </pre> 504 * 505 * <code> 506 * .google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 507 * </code> 508 * 509 * @return Whether the timing field is set. 510 */ hasTiming()511 boolean hasTiming(); 512 /** 513 * 514 * 515 * <pre> 516 * Output only. Stores timing information for executing this build step. 517 * </pre> 518 * 519 * <code> 520 * .google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 521 * </code> 522 * 523 * @return The timing. 524 */ getTiming()525 com.google.cloudbuild.v1.TimeSpan getTiming(); 526 /** 527 * 528 * 529 * <pre> 530 * Output only. Stores timing information for executing this build step. 531 * </pre> 532 * 533 * <code> 534 * .google.devtools.cloudbuild.v1.TimeSpan timing = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; 535 * </code> 536 */ getTimingOrBuilder()537 com.google.cloudbuild.v1.TimeSpanOrBuilder getTimingOrBuilder(); 538 539 /** 540 * 541 * 542 * <pre> 543 * Output only. Stores timing information for pulling this build step's 544 * builder image only. 545 * </pre> 546 * 547 * <code> 548 * .google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 549 * </code> 550 * 551 * @return Whether the pullTiming field is set. 552 */ hasPullTiming()553 boolean hasPullTiming(); 554 /** 555 * 556 * 557 * <pre> 558 * Output only. Stores timing information for pulling this build step's 559 * builder image only. 560 * </pre> 561 * 562 * <code> 563 * .google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 564 * </code> 565 * 566 * @return The pullTiming. 567 */ getPullTiming()568 com.google.cloudbuild.v1.TimeSpan getPullTiming(); 569 /** 570 * 571 * 572 * <pre> 573 * Output only. Stores timing information for pulling this build step's 574 * builder image only. 575 * </pre> 576 * 577 * <code> 578 * .google.devtools.cloudbuild.v1.TimeSpan pull_timing = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 579 * </code> 580 */ getPullTimingOrBuilder()581 com.google.cloudbuild.v1.TimeSpanOrBuilder getPullTimingOrBuilder(); 582 583 /** 584 * 585 * 586 * <pre> 587 * Time limit for executing this build step. If not defined, the step has no 588 * time limit and will be allowed to continue to run until either it completes 589 * or the build itself times out. 590 * </pre> 591 * 592 * <code>.google.protobuf.Duration timeout = 11;</code> 593 * 594 * @return Whether the timeout field is set. 595 */ hasTimeout()596 boolean hasTimeout(); 597 /** 598 * 599 * 600 * <pre> 601 * Time limit for executing this build step. If not defined, the step has no 602 * time limit and will be allowed to continue to run until either it completes 603 * or the build itself times out. 604 * </pre> 605 * 606 * <code>.google.protobuf.Duration timeout = 11;</code> 607 * 608 * @return The timeout. 609 */ getTimeout()610 com.google.protobuf.Duration getTimeout(); 611 /** 612 * 613 * 614 * <pre> 615 * Time limit for executing this build step. If not defined, the step has no 616 * time limit and will be allowed to continue to run until either it completes 617 * or the build itself times out. 618 * </pre> 619 * 620 * <code>.google.protobuf.Duration timeout = 11;</code> 621 */ getTimeoutOrBuilder()622 com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder(); 623 624 /** 625 * 626 * 627 * <pre> 628 * Output only. Status of the build step. At this time, build step status is 629 * only updated on build completion; step status is not updated in real-time 630 * as the build progresses. 631 * </pre> 632 * 633 * <code> 634 * .google.devtools.cloudbuild.v1.Build.Status status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 635 * </code> 636 * 637 * @return The enum numeric value on the wire for status. 638 */ getStatusValue()639 int getStatusValue(); 640 /** 641 * 642 * 643 * <pre> 644 * Output only. Status of the build step. At this time, build step status is 645 * only updated on build completion; step status is not updated in real-time 646 * as the build progresses. 647 * </pre> 648 * 649 * <code> 650 * .google.devtools.cloudbuild.v1.Build.Status status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 651 * </code> 652 * 653 * @return The status. 654 */ getStatus()655 com.google.cloudbuild.v1.Build.Status getStatus(); 656 657 /** 658 * 659 * 660 * <pre> 661 * Allow this build step to fail without failing the entire build. 662 * If false, the entire build will fail if this step fails. Otherwise, the 663 * build will succeed, but this step will still have a failure status. 664 * Error information will be reported in the failure_detail field. 665 * </pre> 666 * 667 * <code>bool allow_failure = 14;</code> 668 * 669 * @return The allowFailure. 670 */ getAllowFailure()671 boolean getAllowFailure(); 672 673 /** 674 * 675 * 676 * <pre> 677 * Output only. Return code from running the step. 678 * </pre> 679 * 680 * <code>int32 exit_code = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 681 * 682 * @return The exitCode. 683 */ getExitCode()684 int getExitCode(); 685 686 /** 687 * 688 * 689 * <pre> 690 * Allow this build step to fail without failing the entire build if and 691 * only if the exit code is one of the specified codes. If allow_failure 692 * is also specified, this field will take precedence. 693 * </pre> 694 * 695 * <code>repeated int32 allow_exit_codes = 18;</code> 696 * 697 * @return A list containing the allowExitCodes. 698 */ getAllowExitCodesList()699 java.util.List<java.lang.Integer> getAllowExitCodesList(); 700 /** 701 * 702 * 703 * <pre> 704 * Allow this build step to fail without failing the entire build if and 705 * only if the exit code is one of the specified codes. If allow_failure 706 * is also specified, this field will take precedence. 707 * </pre> 708 * 709 * <code>repeated int32 allow_exit_codes = 18;</code> 710 * 711 * @return The count of allowExitCodes. 712 */ getAllowExitCodesCount()713 int getAllowExitCodesCount(); 714 /** 715 * 716 * 717 * <pre> 718 * Allow this build step to fail without failing the entire build if and 719 * only if the exit code is one of the specified codes. If allow_failure 720 * is also specified, this field will take precedence. 721 * </pre> 722 * 723 * <code>repeated int32 allow_exit_codes = 18;</code> 724 * 725 * @param index The index of the element to return. 726 * @return The allowExitCodes at the given index. 727 */ getAllowExitCodes(int index)728 int getAllowExitCodes(int index); 729 730 /** 731 * 732 * 733 * <pre> 734 * A shell script to be executed in the step. 735 * When script is provided, the user cannot specify the entrypoint or args. 736 * </pre> 737 * 738 * <code>string script = 19;</code> 739 * 740 * @return The script. 741 */ getScript()742 java.lang.String getScript(); 743 /** 744 * 745 * 746 * <pre> 747 * A shell script to be executed in the step. 748 * When script is provided, the user cannot specify the entrypoint or args. 749 * </pre> 750 * 751 * <code>string script = 19;</code> 752 * 753 * @return The bytes for script. 754 */ getScriptBytes()755 com.google.protobuf.ByteString getScriptBytes(); 756 } 757