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 BuildOptionsOrBuilder
22     extends
23     // @@protoc_insertion_point(interface_extends:google.devtools.cloudbuild.v1.BuildOptions)
24     com.google.protobuf.MessageOrBuilder {
25 
26   /**
27    *
28    *
29    * <pre>
30    * Requested hash for SourceProvenance.
31    * </pre>
32    *
33    * <code>repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;</code>
34    *
35    * @return A list containing the sourceProvenanceHash.
36    */
getSourceProvenanceHashList()37   java.util.List<com.google.cloudbuild.v1.Hash.HashType> getSourceProvenanceHashList();
38   /**
39    *
40    *
41    * <pre>
42    * Requested hash for SourceProvenance.
43    * </pre>
44    *
45    * <code>repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;</code>
46    *
47    * @return The count of sourceProvenanceHash.
48    */
getSourceProvenanceHashCount()49   int getSourceProvenanceHashCount();
50   /**
51    *
52    *
53    * <pre>
54    * Requested hash for SourceProvenance.
55    * </pre>
56    *
57    * <code>repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;</code>
58    *
59    * @param index The index of the element to return.
60    * @return The sourceProvenanceHash at the given index.
61    */
getSourceProvenanceHash(int index)62   com.google.cloudbuild.v1.Hash.HashType getSourceProvenanceHash(int index);
63   /**
64    *
65    *
66    * <pre>
67    * Requested hash for SourceProvenance.
68    * </pre>
69    *
70    * <code>repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;</code>
71    *
72    * @return A list containing the enum numeric values on the wire for sourceProvenanceHash.
73    */
getSourceProvenanceHashValueList()74   java.util.List<java.lang.Integer> getSourceProvenanceHashValueList();
75   /**
76    *
77    *
78    * <pre>
79    * Requested hash for SourceProvenance.
80    * </pre>
81    *
82    * <code>repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;</code>
83    *
84    * @param index The index of the value to return.
85    * @return The enum numeric value on the wire of sourceProvenanceHash at the given index.
86    */
getSourceProvenanceHashValue(int index)87   int getSourceProvenanceHashValue(int index);
88 
89   /**
90    *
91    *
92    * <pre>
93    * Requested verifiability options.
94    * </pre>
95    *
96    * <code>.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
97    * </code>
98    *
99    * @return The enum numeric value on the wire for requestedVerifyOption.
100    */
getRequestedVerifyOptionValue()101   int getRequestedVerifyOptionValue();
102   /**
103    *
104    *
105    * <pre>
106    * Requested verifiability options.
107    * </pre>
108    *
109    * <code>.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
110    * </code>
111    *
112    * @return The requestedVerifyOption.
113    */
getRequestedVerifyOption()114   com.google.cloudbuild.v1.BuildOptions.VerifyOption getRequestedVerifyOption();
115 
116   /**
117    *
118    *
119    * <pre>
120    * Compute Engine machine type on which to run the build.
121    * </pre>
122    *
123    * <code>.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;</code>
124    *
125    * @return The enum numeric value on the wire for machineType.
126    */
getMachineTypeValue()127   int getMachineTypeValue();
128   /**
129    *
130    *
131    * <pre>
132    * Compute Engine machine type on which to run the build.
133    * </pre>
134    *
135    * <code>.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;</code>
136    *
137    * @return The machineType.
138    */
getMachineType()139   com.google.cloudbuild.v1.BuildOptions.MachineType getMachineType();
140 
141   /**
142    *
143    *
144    * <pre>
145    * Requested disk size for the VM that runs the build. Note that this is *NOT*
146    * "disk free"; some of the space will be used by the operating system and
147    * build utilities. Also note that this is the minimum disk size that will be
148    * allocated for the build -- the build may run with a larger disk than
149    * requested. At present, the maximum disk size is 2000GB; builds that request
150    * more than the maximum are rejected with an error.
151    * </pre>
152    *
153    * <code>int64 disk_size_gb = 6;</code>
154    *
155    * @return The diskSizeGb.
156    */
getDiskSizeGb()157   long getDiskSizeGb();
158 
159   /**
160    *
161    *
162    * <pre>
163    * Option to specify behavior when there is an error in the substitution
164    * checks.
165    * NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot
166    * be overridden in the build configuration file.
167    * </pre>
168    *
169    * <code>.google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
170    * </code>
171    *
172    * @return The enum numeric value on the wire for substitutionOption.
173    */
getSubstitutionOptionValue()174   int getSubstitutionOptionValue();
175   /**
176    *
177    *
178    * <pre>
179    * Option to specify behavior when there is an error in the substitution
180    * checks.
181    * NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot
182    * be overridden in the build configuration file.
183    * </pre>
184    *
185    * <code>.google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
186    * </code>
187    *
188    * @return The substitutionOption.
189    */
getSubstitutionOption()190   com.google.cloudbuild.v1.BuildOptions.SubstitutionOption getSubstitutionOption();
191 
192   /**
193    *
194    *
195    * <pre>
196    * Option to specify whether or not to apply bash style string
197    * operations to the substitutions.
198    * NOTE: this is always enabled for triggered builds and cannot be
199    * overridden in the build configuration file.
200    * </pre>
201    *
202    * <code>bool dynamic_substitutions = 17;</code>
203    *
204    * @return The dynamicSubstitutions.
205    */
getDynamicSubstitutions()206   boolean getDynamicSubstitutions();
207 
208   /**
209    *
210    *
211    * <pre>
212    * Option to define build log streaming behavior to Google Cloud
213    * Storage.
214    * </pre>
215    *
216    * <code>.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
217    * </code>
218    *
219    * @return The enum numeric value on the wire for logStreamingOption.
220    */
getLogStreamingOptionValue()221   int getLogStreamingOptionValue();
222   /**
223    *
224    *
225    * <pre>
226    * Option to define build log streaming behavior to Google Cloud
227    * Storage.
228    * </pre>
229    *
230    * <code>.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
231    * </code>
232    *
233    * @return The logStreamingOption.
234    */
getLogStreamingOption()235   com.google.cloudbuild.v1.BuildOptions.LogStreamingOption getLogStreamingOption();
236 
237   /**
238    *
239    *
240    * <pre>
241    * This field deprecated; please use `pool.name` instead.
242    * </pre>
243    *
244    * <code>string worker_pool = 7 [deprecated = true];</code>
245    *
246    * @deprecated google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See
247    *     google/devtools/cloudbuild/v1/cloudbuild.proto;l=1969
248    * @return The workerPool.
249    */
250   @java.lang.Deprecated
getWorkerPool()251   java.lang.String getWorkerPool();
252   /**
253    *
254    *
255    * <pre>
256    * This field deprecated; please use `pool.name` instead.
257    * </pre>
258    *
259    * <code>string worker_pool = 7 [deprecated = true];</code>
260    *
261    * @deprecated google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See
262    *     google/devtools/cloudbuild/v1/cloudbuild.proto;l=1969
263    * @return The bytes for workerPool.
264    */
265   @java.lang.Deprecated
getWorkerPoolBytes()266   com.google.protobuf.ByteString getWorkerPoolBytes();
267 
268   /**
269    *
270    *
271    * <pre>
272    * Optional. Specification for execution on a `WorkerPool`.
273    * See [running builds in a private
274    * pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
275    * for more information.
276    * </pre>
277    *
278    * <code>
279    * .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
280    * </code>
281    *
282    * @return Whether the pool field is set.
283    */
hasPool()284   boolean hasPool();
285   /**
286    *
287    *
288    * <pre>
289    * Optional. Specification for execution on a `WorkerPool`.
290    * See [running builds in a private
291    * pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
292    * for more information.
293    * </pre>
294    *
295    * <code>
296    * .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
297    * </code>
298    *
299    * @return The pool.
300    */
getPool()301   com.google.cloudbuild.v1.BuildOptions.PoolOption getPool();
302   /**
303    *
304    *
305    * <pre>
306    * Optional. Specification for execution on a `WorkerPool`.
307    * See [running builds in a private
308    * pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
309    * for more information.
310    * </pre>
311    *
312    * <code>
313    * .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
314    * </code>
315    */
getPoolOrBuilder()316   com.google.cloudbuild.v1.BuildOptions.PoolOptionOrBuilder getPoolOrBuilder();
317 
318   /**
319    *
320    *
321    * <pre>
322    * Option to specify the logging mode, which determines if and where build
323    * logs are stored.
324    * </pre>
325    *
326    * <code>.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;</code>
327    *
328    * @return The enum numeric value on the wire for logging.
329    */
getLoggingValue()330   int getLoggingValue();
331   /**
332    *
333    *
334    * <pre>
335    * Option to specify the logging mode, which determines if and where build
336    * logs are stored.
337    * </pre>
338    *
339    * <code>.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;</code>
340    *
341    * @return The logging.
342    */
getLogging()343   com.google.cloudbuild.v1.BuildOptions.LoggingMode getLogging();
344 
345   /**
346    *
347    *
348    * <pre>
349    * A list of global environment variable definitions that will exist for all
350    * build steps in this build. If a variable is defined in both globally and in
351    * a build step, the variable will use the build step value.
352    * The elements are of the form "KEY=VALUE" for the environment variable "KEY"
353    * being given the value "VALUE".
354    * </pre>
355    *
356    * <code>repeated string env = 12;</code>
357    *
358    * @return A list containing the env.
359    */
getEnvList()360   java.util.List<java.lang.String> getEnvList();
361   /**
362    *
363    *
364    * <pre>
365    * A list of global environment variable definitions that will exist for all
366    * build steps in this build. If a variable is defined in both globally and in
367    * a build step, the variable will use the build step value.
368    * The elements are of the form "KEY=VALUE" for the environment variable "KEY"
369    * being given the value "VALUE".
370    * </pre>
371    *
372    * <code>repeated string env = 12;</code>
373    *
374    * @return The count of env.
375    */
getEnvCount()376   int getEnvCount();
377   /**
378    *
379    *
380    * <pre>
381    * A list of global environment variable definitions that will exist for all
382    * build steps in this build. If a variable is defined in both globally and in
383    * a build step, the variable will use the build step value.
384    * The elements are of the form "KEY=VALUE" for the environment variable "KEY"
385    * being given the value "VALUE".
386    * </pre>
387    *
388    * <code>repeated string env = 12;</code>
389    *
390    * @param index The index of the element to return.
391    * @return The env at the given index.
392    */
getEnv(int index)393   java.lang.String getEnv(int index);
394   /**
395    *
396    *
397    * <pre>
398    * A list of global environment variable definitions that will exist for all
399    * build steps in this build. If a variable is defined in both globally and in
400    * a build step, the variable will use the build step value.
401    * The elements are of the form "KEY=VALUE" for the environment variable "KEY"
402    * being given the value "VALUE".
403    * </pre>
404    *
405    * <code>repeated string env = 12;</code>
406    *
407    * @param index The index of the value to return.
408    * @return The bytes of the env at the given index.
409    */
getEnvBytes(int index)410   com.google.protobuf.ByteString getEnvBytes(int index);
411 
412   /**
413    *
414    *
415    * <pre>
416    * A list of global environment variables, which are encrypted using a Cloud
417    * Key Management Service crypto key. These values must be specified in the
418    * build's `Secret`. These variables will be available to all build steps
419    * in this build.
420    * </pre>
421    *
422    * <code>repeated string secret_env = 13;</code>
423    *
424    * @return A list containing the secretEnv.
425    */
getSecretEnvList()426   java.util.List<java.lang.String> getSecretEnvList();
427   /**
428    *
429    *
430    * <pre>
431    * A list of global environment variables, which are encrypted using a Cloud
432    * Key Management Service crypto key. These values must be specified in the
433    * build's `Secret`. These variables will be available to all build steps
434    * in this build.
435    * </pre>
436    *
437    * <code>repeated string secret_env = 13;</code>
438    *
439    * @return The count of secretEnv.
440    */
getSecretEnvCount()441   int getSecretEnvCount();
442   /**
443    *
444    *
445    * <pre>
446    * A list of global environment variables, which are encrypted using a Cloud
447    * Key Management Service crypto key. These values must be specified in the
448    * build's `Secret`. These variables will be available to all build steps
449    * in this build.
450    * </pre>
451    *
452    * <code>repeated string secret_env = 13;</code>
453    *
454    * @param index The index of the element to return.
455    * @return The secretEnv at the given index.
456    */
getSecretEnv(int index)457   java.lang.String getSecretEnv(int index);
458   /**
459    *
460    *
461    * <pre>
462    * A list of global environment variables, which are encrypted using a Cloud
463    * Key Management Service crypto key. These values must be specified in the
464    * build's `Secret`. These variables will be available to all build steps
465    * in this build.
466    * </pre>
467    *
468    * <code>repeated string secret_env = 13;</code>
469    *
470    * @param index The index of the value to return.
471    * @return The bytes of the secretEnv at the given index.
472    */
getSecretEnvBytes(int index)473   com.google.protobuf.ByteString getSecretEnvBytes(int index);
474 
475   /**
476    *
477    *
478    * <pre>
479    * Global list of volumes to mount for ALL build steps
480    * Each volume is created as an empty volume prior to starting the build
481    * process. Upon completion of the build, volumes and their contents are
482    * discarded. Global volume names and paths cannot conflict with the volumes
483    * defined a build step.
484    * Using a global volume in a build with only one step is not valid as
485    * it is indicative of a build request with an incorrect configuration.
486    * </pre>
487    *
488    * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;</code>
489    */
getVolumesList()490   java.util.List<com.google.cloudbuild.v1.Volume> getVolumesList();
491   /**
492    *
493    *
494    * <pre>
495    * Global list of volumes to mount for ALL build steps
496    * Each volume is created as an empty volume prior to starting the build
497    * process. Upon completion of the build, volumes and their contents are
498    * discarded. Global volume names and paths cannot conflict with the volumes
499    * defined a build step.
500    * Using a global volume in a build with only one step is not valid as
501    * it is indicative of a build request with an incorrect configuration.
502    * </pre>
503    *
504    * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;</code>
505    */
getVolumes(int index)506   com.google.cloudbuild.v1.Volume getVolumes(int index);
507   /**
508    *
509    *
510    * <pre>
511    * Global list of volumes to mount for ALL build steps
512    * Each volume is created as an empty volume prior to starting the build
513    * process. Upon completion of the build, volumes and their contents are
514    * discarded. Global volume names and paths cannot conflict with the volumes
515    * defined a build step.
516    * Using a global volume in a build with only one step is not valid as
517    * it is indicative of a build request with an incorrect configuration.
518    * </pre>
519    *
520    * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;</code>
521    */
getVolumesCount()522   int getVolumesCount();
523   /**
524    *
525    *
526    * <pre>
527    * Global list of volumes to mount for ALL build steps
528    * Each volume is created as an empty volume prior to starting the build
529    * process. Upon completion of the build, volumes and their contents are
530    * discarded. Global volume names and paths cannot conflict with the volumes
531    * defined a build step.
532    * Using a global volume in a build with only one step is not valid as
533    * it is indicative of a build request with an incorrect configuration.
534    * </pre>
535    *
536    * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;</code>
537    */
getVolumesOrBuilderList()538   java.util.List<? extends com.google.cloudbuild.v1.VolumeOrBuilder> getVolumesOrBuilderList();
539   /**
540    *
541    *
542    * <pre>
543    * Global list of volumes to mount for ALL build steps
544    * Each volume is created as an empty volume prior to starting the build
545    * process. Upon completion of the build, volumes and their contents are
546    * discarded. Global volume names and paths cannot conflict with the volumes
547    * defined a build step.
548    * Using a global volume in a build with only one step is not valid as
549    * it is indicative of a build request with an incorrect configuration.
550    * </pre>
551    *
552    * <code>repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;</code>
553    */
getVolumesOrBuilder(int index)554   com.google.cloudbuild.v1.VolumeOrBuilder getVolumesOrBuilder(int index);
555 
556   /**
557    *
558    *
559    * <pre>
560    * Optional. Option to specify how default logs buckets are setup.
561    * </pre>
562    *
563    * <code>
564    * .google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior default_logs_bucket_behavior = 21 [(.google.api.field_behavior) = OPTIONAL];
565    * </code>
566    *
567    * @return The enum numeric value on the wire for defaultLogsBucketBehavior.
568    */
getDefaultLogsBucketBehaviorValue()569   int getDefaultLogsBucketBehaviorValue();
570   /**
571    *
572    *
573    * <pre>
574    * Optional. Option to specify how default logs buckets are setup.
575    * </pre>
576    *
577    * <code>
578    * .google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior default_logs_bucket_behavior = 21 [(.google.api.field_behavior) = OPTIONAL];
579    * </code>
580    *
581    * @return The defaultLogsBucketBehavior.
582    */
getDefaultLogsBucketBehavior()583   com.google.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior getDefaultLogsBucketBehavior();
584 }
585