com.google.cloudbuild.v1.BuildOptionsOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-build-v1 Show documentation
Show all versions of proto-google-cloud-build-v1 Show documentation
PROTO library for proto-google-cloud-build-v1
The newest version!
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/devtools/cloudbuild/v1/cloudbuild.proto
// Protobuf Java Version: 3.25.4
package com.google.cloudbuild.v1;
public interface BuildOptionsOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.devtools.cloudbuild.v1.BuildOptions)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Requested hash for SourceProvenance.
*
*
* repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
*
* @return A list containing the sourceProvenanceHash.
*/
java.util.List getSourceProvenanceHashList();
/**
*
*
*
* Requested hash for SourceProvenance.
*
*
* repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
*
* @return The count of sourceProvenanceHash.
*/
int getSourceProvenanceHashCount();
/**
*
*
*
* Requested hash for SourceProvenance.
*
*
* repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
*
* @param index The index of the element to return.
* @return The sourceProvenanceHash at the given index.
*/
com.google.cloudbuild.v1.Hash.HashType getSourceProvenanceHash(int index);
/**
*
*
*
* Requested hash for SourceProvenance.
*
*
* repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
*
* @return A list containing the enum numeric values on the wire for sourceProvenanceHash.
*/
java.util.List getSourceProvenanceHashValueList();
/**
*
*
*
* Requested hash for SourceProvenance.
*
*
* repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
*
* @param index The index of the value to return.
* @return The enum numeric value on the wire of sourceProvenanceHash at the given index.
*/
int getSourceProvenanceHashValue(int index);
/**
*
*
*
* Requested verifiability options.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
*
*
* @return The enum numeric value on the wire for requestedVerifyOption.
*/
int getRequestedVerifyOptionValue();
/**
*
*
*
* Requested verifiability options.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
*
*
* @return The requestedVerifyOption.
*/
com.google.cloudbuild.v1.BuildOptions.VerifyOption getRequestedVerifyOption();
/**
*
*
*
* Compute Engine machine type on which to run the build.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
*
* @return The enum numeric value on the wire for machineType.
*/
int getMachineTypeValue();
/**
*
*
*
* Compute Engine machine type on which to run the build.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
*
* @return The machineType.
*/
com.google.cloudbuild.v1.BuildOptions.MachineType getMachineType();
/**
*
*
*
* Requested disk size for the VM that runs the build. Note that this is *NOT*
* "disk free"; some of the space will be used by the operating system and
* build utilities. Also note that this is the minimum disk size that will be
* allocated for the build -- the build may run with a larger disk than
* requested. At present, the maximum disk size is 2000GB; builds that request
* more than the maximum are rejected with an error.
*
*
* int64 disk_size_gb = 6;
*
* @return The diskSizeGb.
*/
long getDiskSizeGb();
/**
*
*
*
* Option to specify behavior when there is an error in the substitution
* checks.
*
* NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot
* be overridden in the build configuration file.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
*
*
* @return The enum numeric value on the wire for substitutionOption.
*/
int getSubstitutionOptionValue();
/**
*
*
*
* Option to specify behavior when there is an error in the substitution
* checks.
*
* NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot
* be overridden in the build configuration file.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
*
*
* @return The substitutionOption.
*/
com.google.cloudbuild.v1.BuildOptions.SubstitutionOption getSubstitutionOption();
/**
*
*
*
* Option to specify whether or not to apply bash style string
* operations to the substitutions.
*
* NOTE: this is always enabled for triggered builds and cannot be
* overridden in the build configuration file.
*
*
* bool dynamic_substitutions = 17;
*
* @return The dynamicSubstitutions.
*/
boolean getDynamicSubstitutions();
/**
*
*
*
* Option to include built-in and custom substitutions as env variables
* for all build steps.
*
*
* bool automap_substitutions = 22;
*
* @return The automapSubstitutions.
*/
boolean getAutomapSubstitutions();
/**
*
*
*
* Option to define build log streaming behavior to Cloud
* Storage.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
*
*
* @return The enum numeric value on the wire for logStreamingOption.
*/
int getLogStreamingOptionValue();
/**
*
*
*
* Option to define build log streaming behavior to Cloud
* Storage.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
*
*
* @return The logStreamingOption.
*/
com.google.cloudbuild.v1.BuildOptions.LogStreamingOption getLogStreamingOption();
/**
*
*
*
* This field deprecated; please use `pool.name` instead.
*
*
* string worker_pool = 7 [deprecated = true];
*
* @deprecated google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See
* google/devtools/cloudbuild/v1/cloudbuild.proto;l=2284
* @return The workerPool.
*/
@java.lang.Deprecated
java.lang.String getWorkerPool();
/**
*
*
*
* This field deprecated; please use `pool.name` instead.
*
*
* string worker_pool = 7 [deprecated = true];
*
* @deprecated google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See
* google/devtools/cloudbuild/v1/cloudbuild.proto;l=2284
* @return The bytes for workerPool.
*/
@java.lang.Deprecated
com.google.protobuf.ByteString getWorkerPoolBytes();
/**
*
*
*
* Optional. Specification for execution on a `WorkerPool`.
*
* See [running builds in a private
* pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
* for more information.
*
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the pool field is set.
*/
boolean hasPool();
/**
*
*
*
* Optional. Specification for execution on a `WorkerPool`.
*
* See [running builds in a private
* pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
* for more information.
*
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The pool.
*/
com.google.cloudbuild.v1.BuildOptions.PoolOption getPool();
/**
*
*
*
* Optional. Specification for execution on a `WorkerPool`.
*
* See [running builds in a private
* pool](https://cloud.google.com/build/docs/private-pools/run-builds-in-private-pool)
* for more information.
*
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.cloudbuild.v1.BuildOptions.PoolOptionOrBuilder getPoolOrBuilder();
/**
*
*
*
* Option to specify the logging mode, which determines if and where build
* logs are stored.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
*
* @return The enum numeric value on the wire for logging.
*/
int getLoggingValue();
/**
*
*
*
* Option to specify the logging mode, which determines if and where build
* logs are stored.
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
*
* @return The logging.
*/
com.google.cloudbuild.v1.BuildOptions.LoggingMode getLogging();
/**
*
*
*
* A list of global environment variable definitions that will exist for all
* build steps in this build. If a variable is defined in both globally and in
* a build step, the variable will use the build step value.
*
* The elements are of the form "KEY=VALUE" for the environment variable "KEY"
* being given the value "VALUE".
*
*
* repeated string env = 12;
*
* @return A list containing the env.
*/
java.util.List getEnvList();
/**
*
*
*
* A list of global environment variable definitions that will exist for all
* build steps in this build. If a variable is defined in both globally and in
* a build step, the variable will use the build step value.
*
* The elements are of the form "KEY=VALUE" for the environment variable "KEY"
* being given the value "VALUE".
*
*
* repeated string env = 12;
*
* @return The count of env.
*/
int getEnvCount();
/**
*
*
*
* A list of global environment variable definitions that will exist for all
* build steps in this build. If a variable is defined in both globally and in
* a build step, the variable will use the build step value.
*
* The elements are of the form "KEY=VALUE" for the environment variable "KEY"
* being given the value "VALUE".
*
*
* repeated string env = 12;
*
* @param index The index of the element to return.
* @return The env at the given index.
*/
java.lang.String getEnv(int index);
/**
*
*
*
* A list of global environment variable definitions that will exist for all
* build steps in this build. If a variable is defined in both globally and in
* a build step, the variable will use the build step value.
*
* The elements are of the form "KEY=VALUE" for the environment variable "KEY"
* being given the value "VALUE".
*
*
* repeated string env = 12;
*
* @param index The index of the value to return.
* @return The bytes of the env at the given index.
*/
com.google.protobuf.ByteString getEnvBytes(int index);
/**
*
*
*
* A list of global environment variables, which are encrypted using a Cloud
* Key Management Service crypto key. These values must be specified in the
* build's `Secret`. These variables will be available to all build steps
* in this build.
*
*
* repeated string secret_env = 13;
*
* @return A list containing the secretEnv.
*/
java.util.List getSecretEnvList();
/**
*
*
*
* A list of global environment variables, which are encrypted using a Cloud
* Key Management Service crypto key. These values must be specified in the
* build's `Secret`. These variables will be available to all build steps
* in this build.
*
*
* repeated string secret_env = 13;
*
* @return The count of secretEnv.
*/
int getSecretEnvCount();
/**
*
*
*
* A list of global environment variables, which are encrypted using a Cloud
* Key Management Service crypto key. These values must be specified in the
* build's `Secret`. These variables will be available to all build steps
* in this build.
*
*
* repeated string secret_env = 13;
*
* @param index The index of the element to return.
* @return The secretEnv at the given index.
*/
java.lang.String getSecretEnv(int index);
/**
*
*
*
* A list of global environment variables, which are encrypted using a Cloud
* Key Management Service crypto key. These values must be specified in the
* build's `Secret`. These variables will be available to all build steps
* in this build.
*
*
* repeated string secret_env = 13;
*
* @param index The index of the value to return.
* @return The bytes of the secretEnv at the given index.
*/
com.google.protobuf.ByteString getSecretEnvBytes(int index);
/**
*
*
*
* Global list of volumes to mount for ALL build steps
*
* Each volume is created as an empty volume prior to starting the build
* process. Upon completion of the build, volumes and their contents are
* discarded. Global volume names and paths cannot conflict with the volumes
* defined a build step.
*
* Using a global volume in a build with only one step is not valid as
* it is indicative of a build request with an incorrect configuration.
*
*
* repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;
*/
java.util.List getVolumesList();
/**
*
*
*
* Global list of volumes to mount for ALL build steps
*
* Each volume is created as an empty volume prior to starting the build
* process. Upon completion of the build, volumes and their contents are
* discarded. Global volume names and paths cannot conflict with the volumes
* defined a build step.
*
* Using a global volume in a build with only one step is not valid as
* it is indicative of a build request with an incorrect configuration.
*
*
* repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;
*/
com.google.cloudbuild.v1.Volume getVolumes(int index);
/**
*
*
*
* Global list of volumes to mount for ALL build steps
*
* Each volume is created as an empty volume prior to starting the build
* process. Upon completion of the build, volumes and their contents are
* discarded. Global volume names and paths cannot conflict with the volumes
* defined a build step.
*
* Using a global volume in a build with only one step is not valid as
* it is indicative of a build request with an incorrect configuration.
*
*
* repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;
*/
int getVolumesCount();
/**
*
*
*
* Global list of volumes to mount for ALL build steps
*
* Each volume is created as an empty volume prior to starting the build
* process. Upon completion of the build, volumes and their contents are
* discarded. Global volume names and paths cannot conflict with the volumes
* defined a build step.
*
* Using a global volume in a build with only one step is not valid as
* it is indicative of a build request with an incorrect configuration.
*
*
* repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;
*/
java.util.List getVolumesOrBuilderList();
/**
*
*
*
* Global list of volumes to mount for ALL build steps
*
* Each volume is created as an empty volume prior to starting the build
* process. Upon completion of the build, volumes and their contents are
* discarded. Global volume names and paths cannot conflict with the volumes
* defined a build step.
*
* Using a global volume in a build with only one step is not valid as
* it is indicative of a build request with an incorrect configuration.
*
*
* repeated .google.devtools.cloudbuild.v1.Volume volumes = 14;
*/
com.google.cloudbuild.v1.VolumeOrBuilder getVolumesOrBuilder(int index);
/**
*
*
*
* Optional. Option to specify how default logs buckets are setup.
*
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior default_logs_bucket_behavior = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for defaultLogsBucketBehavior.
*/
int getDefaultLogsBucketBehaviorValue();
/**
*
*
*
* Optional. Option to specify how default logs buckets are setup.
*
*
*
* .google.devtools.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior default_logs_bucket_behavior = 21 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The defaultLogsBucketBehavior.
*/
com.google.cloudbuild.v1.BuildOptions.DefaultLogsBucketBehavior getDefaultLogsBucketBehavior();
}