public final class BuildOptions extends GeneratedMessageV3 implements BuildOptionsOrBuilder
Optional arguments to enable specific features of builds.
Protobuf type google.devtools.cloudbuild.v1.BuildOptions
Static Fields
DISK_SIZE_GB_FIELD_NUMBER
public static final int DISK_SIZE_GB_FIELD_NUMBER
Field Value
DYNAMIC_SUBSTITUTIONS_FIELD_NUMBER
public static final int DYNAMIC_SUBSTITUTIONS_FIELD_NUMBER
Field Value
ENV_FIELD_NUMBER
public static final int ENV_FIELD_NUMBER
Field Value
LOGGING_FIELD_NUMBER
public static final int LOGGING_FIELD_NUMBER
Field Value
LOG_STREAMING_OPTION_FIELD_NUMBER
public static final int LOG_STREAMING_OPTION_FIELD_NUMBER
Field Value
MACHINE_TYPE_FIELD_NUMBER
public static final int MACHINE_TYPE_FIELD_NUMBER
Field Value
POOL_FIELD_NUMBER
public static final int POOL_FIELD_NUMBER
Field Value
REQUESTED_VERIFY_OPTION_FIELD_NUMBER
public static final int REQUESTED_VERIFY_OPTION_FIELD_NUMBER
Field Value
SECRET_ENV_FIELD_NUMBER
public static final int SECRET_ENV_FIELD_NUMBER
Field Value
SOURCE_PROVENANCE_HASH_FIELD_NUMBER
public static final int SOURCE_PROVENANCE_HASH_FIELD_NUMBER
Field Value
SUBSTITUTION_OPTION_FIELD_NUMBER
public static final int SUBSTITUTION_OPTION_FIELD_NUMBER
Field Value
VOLUMES_FIELD_NUMBER
public static final int VOLUMES_FIELD_NUMBER
Field Value
WORKER_POOL_FIELD_NUMBER
public static final int WORKER_POOL_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static BuildOptions getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static BuildOptions.Builder newBuilder()
Returns
newBuilder(BuildOptions prototype)
public static BuildOptions.Builder newBuilder(BuildOptions prototype)
Parameter
Returns
public static BuildOptions parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static BuildOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static BuildOptions parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BuildOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static BuildOptions parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BuildOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BuildOptions parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static BuildOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static BuildOptions parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static BuildOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static BuildOptions parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BuildOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<BuildOptions> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public BuildOptions getDefaultInstanceForType()
Returns
getDiskSizeGb()
public long getDiskSizeGb()
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 1000GB; builds that request
more than the maximum are rejected with an error.
int64 disk_size_gb = 6;
| Type | Description |
| long | The diskSizeGb.
|
getDynamicSubstitutions()
public boolean getDynamicSubstitutions()
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;
| Type | Description |
| boolean | The dynamicSubstitutions.
|
getEnv(int index)
public 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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The env at the given index.
|
getEnvBytes(int index)
public ByteString getEnvBytes(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;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the env at the given index.
|
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;
| Type | Description |
| int | The count of env.
|
getEnvList()
public ProtocolStringList 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;
getLogStreamingOption()
public BuildOptions.LogStreamingOption getLogStreamingOption()
Option to define build log streaming behavior to Google Cloud
Storage.
.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
getLogStreamingOptionValue()
public int getLogStreamingOptionValue()
Option to define build log streaming behavior to Google Cloud
Storage.
.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
| Type | Description |
| int | The enum numeric value on the wire for logStreamingOption.
|
getLogging()
public BuildOptions.LoggingMode getLogging()
Option to specify the logging mode, which determines if and where build
logs are stored.
.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
getLoggingValue()
public 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;
| Type | Description |
| int | The enum numeric value on the wire for logging.
|
getMachineType()
public BuildOptions.MachineType getMachineType()
Compute Engine machine type on which to run the build.
.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
getMachineTypeValue()
public int getMachineTypeValue()
Compute Engine machine type on which to run the build.
.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
| Type | Description |
| int | The enum numeric value on the wire for machineType.
|
getParserForType()
public Parser<BuildOptions> getParserForType()
Returns
Overrides
getPool()
public BuildOptions.PoolOption getPool()
Optional. Specification for execution on a WorkerPool.
See running builds in a private
pool
for more information.
.google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
getPoolOrBuilder()
public BuildOptions.PoolOptionOrBuilder getPoolOrBuilder()
Optional. Specification for execution on a WorkerPool.
See running builds in a private
pool
for more information.
.google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
getRequestedVerifyOption()
public BuildOptions.VerifyOption getRequestedVerifyOption()
Requested verifiability options.
.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
getRequestedVerifyOptionValue()
public int getRequestedVerifyOptionValue()
Requested verifiability options.
.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
| Type | Description |
| int | The enum numeric value on the wire for requestedVerifyOption.
|
getSecretEnv(int index)
public 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;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| String | The secretEnv at the given index.
|
getSecretEnvBytes(int index)
public ByteString getSecretEnvBytes(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;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| ByteString | The bytes of the secretEnv at the given index.
|
getSecretEnvCount()
public 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;
| Type | Description |
| int | The count of secretEnv.
|
getSecretEnvList()
public ProtocolStringList 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;
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceProvenanceHash(int index)
public Hash.HashType getSourceProvenanceHash(int index)
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| Hash.HashType | The sourceProvenanceHash at the given index.
|
getSourceProvenanceHashCount()
public int getSourceProvenanceHashCount()
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Type | Description |
| int | The count of sourceProvenanceHash.
|
getSourceProvenanceHashList()
public List<Hash.HashType> getSourceProvenanceHashList()
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Type | Description |
| List<HashType> | A list containing the sourceProvenanceHash.
|
getSourceProvenanceHashValue(int index)
public int getSourceProvenanceHashValue(int index)
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| int | The enum numeric value on the wire of sourceProvenanceHash at the given index.
|
getSourceProvenanceHashValueList()
public List<Integer> getSourceProvenanceHashValueList()
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Type | Description |
| List<Integer> | A list containing the enum numeric values on the wire for sourceProvenanceHash.
|
getSubstitutionOption()
public BuildOptions.SubstitutionOption getSubstitutionOption()
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;
getSubstitutionOptionValue()
public 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;
| Type | Description |
| int | The enum numeric value on the wire for substitutionOption.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getVolumes(int index)
public 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;
getVolumesCount()
public 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;
getVolumesList()
public List<Volume> 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;
getVolumesOrBuilder(int index)
public VolumeOrBuilder getVolumesOrBuilder(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;
getVolumesOrBuilderList()
public List<? extends VolumeOrBuilder> 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;
| Type | Description |
| List<? extends com.google.cloudbuild.v1.VolumeOrBuilder> | |
getWorkerPool() (deprecated)
public String getWorkerPool()
Deprecated. google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See
google/devtools/cloudbuild/v1/cloudbuild.proto;l=1769
This field deprecated; please use pool.name instead.
string worker_pool = 7 [deprecated = true];
| Type | Description |
| String | The workerPool.
|
getWorkerPoolBytes() (deprecated)
public ByteString getWorkerPoolBytes()
Deprecated. google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See
google/devtools/cloudbuild/v1/cloudbuild.proto;l=1769
This field deprecated; please use pool.name instead.
string worker_pool = 7 [deprecated = true];
| Type | Description |
| ByteString | The bytes for workerPool.
|
hasPool()
Optional. Specification for execution on a WorkerPool.
See running builds in a private
pool
for more information.
.google.devtools.cloudbuild.v1.BuildOptions.PoolOption pool = 19 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| boolean | Whether the pool field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public BuildOptions.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BuildOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public BuildOptions.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
