public static final class BuildOptions.Builder extends GeneratedMessageV3.Builder<BuildOptions.Builder> implements BuildOptionsOrBuilderOptional arguments to enable specific features of builds.
Protobuf type google.events.cloud.cloudbuild.v1.BuildOptions
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BuildOptions.BuilderImplements
BuildOptionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllEnv(Iterable<String> values)
public BuildOptions.Builder addAllEnv(Iterable<String> values)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;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The env to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addAllSecretEnv(Iterable<String> values)
public BuildOptions.Builder addAllSecretEnv(Iterable<String> values) 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;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<String>The secretEnv to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addAllSourceProvenanceHash(Iterable<? extends Hash.HashType> values)
public BuildOptions.Builder addAllSourceProvenanceHash(Iterable<? extends Hash.HashType> values)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.events.cloud.cloudbuild.v1.Hash.HashType>The sourceProvenanceHash to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addAllSourceProvenanceHashValue(Iterable<Integer> values)
public BuildOptions.Builder addAllSourceProvenanceHashValue(Iterable<Integer> values)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<Integer>The enum numeric values on the wire for sourceProvenanceHash to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addAllVolumes(Iterable<? extends Volume> values)
public BuildOptions.Builder addAllVolumes(Iterable<? extends Volume> values)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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
values | Iterable<? extends com.google.events.cloud.cloudbuild.v1.Volume> |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
addEnv(String value)
public BuildOptions.Builder addEnv(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe env to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addEnvBytes(ByteString value)
public BuildOptions.Builder addEnvBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the env to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BuildOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
addSecretEnv(String value)
public BuildOptions.Builder addSecretEnv(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe secretEnv to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addSecretEnvBytes(ByteString value)
public BuildOptions.Builder addSecretEnvBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes of the secretEnv to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addSourceProvenanceHash(Hash.HashType value)
public BuildOptions.Builder addSourceProvenanceHash(Hash.HashType value)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameter | |
|---|---|
| Name | Description |
value | Hash.HashTypeThe sourceProvenanceHash to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addSourceProvenanceHashValue(int value)
public BuildOptions.Builder addSourceProvenanceHashValue(int value)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for sourceProvenanceHash to add. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
addVolumes(Volume value)
public BuildOptions.Builder addVolumes(Volume value)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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
value | Volume |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
addVolumes(Volume.Builder builderForValue)
public BuildOptions.Builder addVolumes(Volume.Builder builderForValue)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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Volume.Builder |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
addVolumes(int index, Volume value)
public BuildOptions.Builder addVolumes(int index, Volume value)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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | Volume |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
addVolumes(int index, Volume.Builder builderForValue)
public BuildOptions.Builder addVolumes(int index, Volume.Builder builderForValue)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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | Volume.Builder |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
addVolumesBuilder()
public Volume.Builder addVolumesBuilder()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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Returns | |
|---|---|
| Type | Description |
Volume.Builder | |
addVolumesBuilder(int index)
public Volume.Builder addVolumesBuilder(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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Volume.Builder | |
build()
public BuildOptions build()| Returns | |
|---|---|
| Type | Description |
BuildOptions | |
buildPartial()
public BuildOptions buildPartial()| Returns | |
|---|---|
| Type | Description |
BuildOptions | |
clear()
public BuildOptions.Builder clear()| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
clearDiskSizeGb()
public BuildOptions.Builder clearDiskSizeGb()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;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearEnv()
public BuildOptions.Builder clearEnv()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;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public BuildOptions.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
clearLogStreamingOption()
public BuildOptions.Builder clearLogStreamingOption()Option to define build log streaming behavior to Google Cloud Storage.
.google.events.cloud.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearLogging()
public BuildOptions.Builder clearLogging()Option to specify the logging mode, which determines where the logs are stored.
.google.events.cloud.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearMachineType()
public BuildOptions.Builder clearMachineType()Compute Engine machine type on which to run the build.
.google.events.cloud.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public BuildOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
clearRequestedVerifyOption()
public BuildOptions.Builder clearRequestedVerifyOption()Requested verifiability options.
.google.events.cloud.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearSecretEnv()
public BuildOptions.Builder clearSecretEnv() 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;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearSourceProvenanceHash()
public BuildOptions.Builder clearSourceProvenanceHash()Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearSubstitutionOption()
public BuildOptions.Builder clearSubstitutionOption()Option to specify behavior when there is an error in the substitution checks.
.google.events.cloud.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clearVolumes()
public BuildOptions.Builder clearVolumes()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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
clearWorkerPool()
public BuildOptions.Builder clearWorkerPool() Option to specify a WorkerPool for the build.
Format: projects/{project}/locations/{location}/workerPools/{workerPool}
string worker_pool = 7;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
clone()
public BuildOptions.Builder clone()| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
getDefaultInstanceForType()
public BuildOptions getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BuildOptions | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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;
| Returns | |
|---|---|
| Type | Description |
long | The diskSizeGb. |
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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the env at the given index. |
getEnvCount()
public 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the env. |
getLogStreamingOption()
public BuildOptions.LogStreamingOption getLogStreamingOption()Option to define build log streaming behavior to Google Cloud Storage.
.google.events.cloud.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.LogStreamingOption | The logStreamingOption. |
getLogStreamingOptionValue()
public int getLogStreamingOptionValue()Option to define build log streaming behavior to Google Cloud Storage.
.google.events.cloud.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
| Returns | |
|---|---|
| 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 where the logs are stored.
.google.events.cloud.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.LoggingMode | The logging. |
getLoggingValue()
public int getLoggingValue()Option to specify the logging mode, which determines where the logs are stored.
.google.events.cloud.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
| Returns | |
|---|---|
| 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.events.cloud.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.MachineType | The machineType. |
getMachineTypeValue()
public int getMachineTypeValue()Compute Engine machine type on which to run the build.
.google.events.cloud.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for machineType. |
getRequestedVerifyOption()
public BuildOptions.VerifyOption getRequestedVerifyOption()Requested verifiability options.
.google.events.cloud.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.VerifyOption | The requestedVerifyOption. |
getRequestedVerifyOptionValue()
public int getRequestedVerifyOptionValue()Requested verifiability options.
.google.events.cloud.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
| Returns | |
|---|---|
| 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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the secretEnv. |
getSourceProvenanceHash(int index)
public Hash.HashType getSourceProvenanceHash(int index)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Returns | |
|---|---|
| Type | Description |
int | The count of sourceProvenanceHash. |
getSourceProvenanceHashList()
public List<Hash.HashType> getSourceProvenanceHashList()Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Returns | |
|---|---|
| Type | Description |
List<HashType> | A list containing the sourceProvenanceHash. |
getSourceProvenanceHashValue(int index)
public int getSourceProvenanceHashValue(int index)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameter | |
|---|---|
| Name | Description |
index | intThe 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.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Returns | |
|---|---|
| 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.
.google.events.cloud.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
| Returns | |
|---|---|
| Type | Description |
BuildOptions.SubstitutionOption | The substitutionOption. |
getSubstitutionOptionValue()
public int getSubstitutionOptionValue()Option to specify behavior when there is an error in the substitution checks.
.google.events.cloud.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for substitutionOption. |
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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Volume | |
getVolumesBuilder(int index)
public Volume.Builder getVolumesBuilder(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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
Volume.Builder | |
getVolumesBuilderList()
public List<Volume.Builder> getVolumesBuilderList()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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Returns | |
|---|---|
| Type | Description |
List<Builder> | |
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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Returns | |
|---|---|
| Type | Description |
int | |
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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Returns | |
|---|---|
| Type | Description |
List<Volume> | |
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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
VolumeOrBuilder | |
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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.events.cloud.cloudbuild.v1.VolumeOrBuilder> | |
getWorkerPool()
public String getWorkerPool() Option to specify a WorkerPool for the build.
Format: projects/{project}/locations/{location}/workerPools/{workerPool}
string worker_pool = 7;
| Returns | |
|---|---|
| Type | Description |
String | The workerPool. |
getWorkerPoolBytes()
public ByteString getWorkerPoolBytes() Option to specify a WorkerPool for the build.
Format: projects/{project}/locations/{location}/workerPools/{workerPool}
string worker_pool = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for workerPool. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(BuildOptions other)
public BuildOptions.Builder mergeFrom(BuildOptions other)| Parameter | |
|---|---|
| Name | Description |
other | BuildOptions |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BuildOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public BuildOptions.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BuildOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
removeVolumes(int index)
public BuildOptions.Builder removeVolumes(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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
setDiskSizeGb(long value)
public BuildOptions.Builder setDiskSizeGb(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value | longThe diskSizeGb to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setEnv(int index, String value)
public BuildOptions.Builder setEnv(int index, String value)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;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe env to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public BuildOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
setLogStreamingOption(BuildOptions.LogStreamingOption value)
public BuildOptions.Builder setLogStreamingOption(BuildOptions.LogStreamingOption value)Option to define build log streaming behavior to Google Cloud Storage.
.google.events.cloud.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
| Parameter | |
|---|---|
| Name | Description |
value | BuildOptions.LogStreamingOptionThe logStreamingOption to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setLogStreamingOptionValue(int value)
public BuildOptions.Builder setLogStreamingOptionValue(int value)Option to define build log streaming behavior to Google Cloud Storage.
.google.events.cloud.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for logStreamingOption to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setLogging(BuildOptions.LoggingMode value)
public BuildOptions.Builder setLogging(BuildOptions.LoggingMode value)Option to specify the logging mode, which determines where the logs are stored.
.google.events.cloud.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
| Parameter | |
|---|---|
| Name | Description |
value | BuildOptions.LoggingModeThe logging to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setLoggingValue(int value)
public BuildOptions.Builder setLoggingValue(int value)Option to specify the logging mode, which determines where the logs are stored.
.google.events.cloud.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for logging to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setMachineType(BuildOptions.MachineType value)
public BuildOptions.Builder setMachineType(BuildOptions.MachineType value)Compute Engine machine type on which to run the build.
.google.events.cloud.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
| Parameter | |
|---|---|
| Name | Description |
value | BuildOptions.MachineTypeThe machineType to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setMachineTypeValue(int value)
public BuildOptions.Builder setMachineTypeValue(int value)Compute Engine machine type on which to run the build.
.google.events.cloud.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for machineType to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BuildOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
setRequestedVerifyOption(BuildOptions.VerifyOption value)
public BuildOptions.Builder setRequestedVerifyOption(BuildOptions.VerifyOption value)Requested verifiability options.
.google.events.cloud.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
| Parameter | |
|---|---|
| Name | Description |
value | BuildOptions.VerifyOptionThe requestedVerifyOption to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setRequestedVerifyOptionValue(int value)
public BuildOptions.Builder setRequestedVerifyOptionValue(int value)Requested verifiability options.
.google.events.cloud.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for requestedVerifyOption to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setSecretEnv(int index, String value)
public BuildOptions.Builder setSecretEnv(int index, String value) 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;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | StringThe secretEnv to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setSourceProvenanceHash(int index, Hash.HashType value)
public BuildOptions.Builder setSourceProvenanceHash(int index, Hash.HashType value)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | Hash.HashTypeThe sourceProvenanceHash to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setSourceProvenanceHashValue(int index, int value)
public BuildOptions.Builder setSourceProvenanceHashValue(int index, int value)Requested hash for SourceProvenance.
repeated .google.events.cloud.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;
| Parameters | |
|---|---|
| Name | Description |
index | intThe index to set the value at. |
value | intThe enum numeric value on the wire for sourceProvenanceHash to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setSubstitutionOption(BuildOptions.SubstitutionOption value)
public BuildOptions.Builder setSubstitutionOption(BuildOptions.SubstitutionOption value)Option to specify behavior when there is an error in the substitution checks.
.google.events.cloud.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
| Parameter | |
|---|---|
| Name | Description |
value | BuildOptions.SubstitutionOptionThe substitutionOption to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setSubstitutionOptionValue(int value)
public BuildOptions.Builder setSubstitutionOptionValue(int value)Option to specify behavior when there is an error in the substitution checks.
.google.events.cloud.cloudbuild.v1.BuildOptions.SubstitutionOption substitution_option = 4;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for substitutionOption to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final BuildOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
setVolumes(int index, Volume value)
public BuildOptions.Builder setVolumes(int index, Volume value)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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | Volume |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
setVolumes(int index, Volume.Builder builderForValue)
public BuildOptions.Builder setVolumes(int index, Volume.Builder builderForValue)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.events.cloud.cloudbuild.v1.Volume volumes = 14;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | Volume.Builder |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | |
setWorkerPool(String value)
public BuildOptions.Builder setWorkerPool(String value) Option to specify a WorkerPool for the build.
Format: projects/{project}/locations/{location}/workerPools/{workerPool}
string worker_pool = 7;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe workerPool to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |
setWorkerPoolBytes(ByteString value)
public BuildOptions.Builder setWorkerPoolBytes(ByteString value) Option to specify a WorkerPool for the build.
Format: projects/{project}/locations/{location}/workerPools/{workerPool}
string worker_pool = 7;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for workerPool to set. |
| Returns | |
|---|---|
| Type | Description |
BuildOptions.Builder | This builder for chaining. |