Package com.google.cloudbuild.v1
Class BuildOptions.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BuildOptions.Builder>
com.google.cloudbuild.v1.BuildOptions.Builder
- All Implemented Interfaces:
BuildOptionsOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- BuildOptions
public static final class BuildOptions.Builder
extends com.google.protobuf.GeneratedMessage.Builder<BuildOptions.Builder>
implements BuildOptionsOrBuilder
Optional arguments to enable specific features of builds.Protobuf type
google.devtools.cloudbuild.v1.BuildOptions-
Method Summary
Modifier and TypeMethodDescriptionA list of global environment variable definitions that will exist for all build steps in this build.addAllSecretEnv(Iterable<String> values) A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.addAllSourceProvenanceHash(Iterable<? extends Hash.HashType> values) Requested hash for SourceProvenance.Requested hash for SourceProvenance.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.A list of global environment variable definitions that will exist for all build steps in this build.addEnvBytes(com.google.protobuf.ByteString value) A list of global environment variable definitions that will exist for all build steps in this build.addSecretEnv(String value) A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.addSecretEnvBytes(com.google.protobuf.ByteString value) A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.Requested hash for SourceProvenance.addSourceProvenanceHashValue(int value) Requested hash for SourceProvenance.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.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.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.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.Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.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.build()clear()Option to include built-in and custom substitutions as env variables for all build steps.Optional.Requested disk size for the VM that runs the build.Option to specify whether or not to apply bash style string operations to the substitutions.Optional.clearEnv()A list of global environment variable definitions that will exist for all build steps in this build.Option to specify the logging mode, which determines if and where build logs are stored.Option to define build log streaming behavior to Cloud Storage.Compute Engine machine type on which to run the build.Optional.Requested verifiability options.A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.Requested hash for SourceProvenance.Option to specify behavior when there is an error in the substitution checks.Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated.booleanOption to include built-in and custom substitutions as env variables for all build steps.Optional.intOptional.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorlongRequested disk size for the VM that runs the build.booleanOption to specify whether or not to apply bash style string operations to the substitutions.booleanOptional.getEnv(int index) A list of global environment variable definitions that will exist for all build steps in this build.com.google.protobuf.ByteStringgetEnvBytes(int index) A list of global environment variable definitions that will exist for all build steps in this build.intA list of global environment variable definitions that will exist for all build steps in this build.com.google.protobuf.ProtocolStringListA list of global environment variable definitions that will exist for all build steps in this build.Option to specify the logging mode, which determines if and where build logs are stored.intOption to specify the logging mode, which determines if and where build logs are stored.Option to define build log streaming behavior to Cloud Storage.intOption to define build log streaming behavior to Cloud Storage.Compute Engine machine type on which to run the build.intCompute Engine machine type on which to run the build.getPool()Optional.Optional.Optional.Requested verifiability options.intRequested verifiability options.getSecretEnv(int index) A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.com.google.protobuf.ByteStringgetSecretEnvBytes(int index) A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.intA list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.com.google.protobuf.ProtocolStringListA list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.getSourceProvenanceHash(int index) Requested hash for SourceProvenance.intRequested hash for SourceProvenance.Requested hash for SourceProvenance.intgetSourceProvenanceHashValue(int index) Requested hash for SourceProvenance.Requested hash for SourceProvenance.Option to specify behavior when there is an error in the substitution checks.intOption to specify behavior when there is an error in the substitution checks.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.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.Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.intGlobal list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.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.List<? extends VolumeOrBuilder>Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process.Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated.com.google.protobuf.ByteStringDeprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated.booleanhasPool()Optional.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(BuildOptions other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergePool(BuildOptions.PoolOption value) Optional.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.setAutomapSubstitutions(boolean value) Option to include built-in and custom substitutions as env variables for all build steps.Optional.setDefaultLogsBucketBehaviorValue(int value) Optional.setDiskSizeGb(long value) Requested disk size for the VM that runs the build.setDynamicSubstitutions(boolean value) Option to specify whether or not to apply bash style string operations to the substitutions.setEnableStructuredLogging(boolean value) Optional.A list of global environment variable definitions that will exist for all build steps in this build.Option to specify the logging mode, which determines if and where build logs are stored.setLoggingValue(int value) Option to specify the logging mode, which determines if and where build logs are stored.Option to define build log streaming behavior to Cloud Storage.setLogStreamingOptionValue(int value) Option to define build log streaming behavior to Cloud Storage.Compute Engine machine type on which to run the build.setMachineTypeValue(int value) Compute Engine machine type on which to run the build.setPool(BuildOptions.PoolOption value) Optional.setPool(BuildOptions.PoolOption.Builder builderForValue) Optional.Requested verifiability options.setRequestedVerifyOptionValue(int value) Requested verifiability options.setSecretEnv(int index, String value) A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key.setSourceProvenanceHash(int index, Hash.HashType value) Requested hash for SourceProvenance.setSourceProvenanceHashValue(int index, int value) Requested hash for SourceProvenance.Option to specify behavior when there is an error in the substitution checks.setSubstitutionOptionValue(int value) Option to specify behavior when there is an error in the substitution checks.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.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.setWorkerPool(String value) Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated.setWorkerPoolBytes(com.google.protobuf.ByteString value) Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<BuildOptions.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<BuildOptions.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<BuildOptions.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<BuildOptions.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<BuildOptions.Builder>
-
mergeFrom
public BuildOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<BuildOptions.Builder>- Throws:
IOException
-
getSourceProvenanceHashList
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Specified by:
getSourceProvenanceHashListin interfaceBuildOptionsOrBuilder- Returns:
- A list containing the sourceProvenanceHash.
-
getSourceProvenanceHashCount
public int getSourceProvenanceHashCount()Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Specified by:
getSourceProvenanceHashCountin interfaceBuildOptionsOrBuilder- Returns:
- The count of sourceProvenanceHash.
-
getSourceProvenanceHash
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Specified by:
getSourceProvenanceHashin interfaceBuildOptionsOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The sourceProvenanceHash at the given index.
-
setSourceProvenanceHash
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Parameters:
index- The index to set the value at.value- The sourceProvenanceHash to set.- Returns:
- This builder for chaining.
-
addSourceProvenanceHash
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Parameters:
value- The sourceProvenanceHash to add.- Returns:
- This builder for chaining.
-
addAllSourceProvenanceHash
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Parameters:
values- The sourceProvenanceHash to add.- Returns:
- This builder for chaining.
-
clearSourceProvenanceHash
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Returns:
- This builder for chaining.
-
getSourceProvenanceHashValueList
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Specified by:
getSourceProvenanceHashValueListin interfaceBuildOptionsOrBuilder- Returns:
- A list containing the enum numeric values on the wire for sourceProvenanceHash.
-
getSourceProvenanceHashValue
public int getSourceProvenanceHashValue(int index) Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Specified by:
getSourceProvenanceHashValuein interfaceBuildOptionsOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of sourceProvenanceHash at the given index.
-
setSourceProvenanceHashValue
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Parameters:
index- The index to set the value at.value- The enum numeric value on the wire for sourceProvenanceHash to set.- Returns:
- This builder for chaining.
-
addSourceProvenanceHashValue
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Parameters:
value- The enum numeric value on the wire for sourceProvenanceHash to add.- Returns:
- This builder for chaining.
-
addAllSourceProvenanceHashValue
Requested hash for SourceProvenance.
repeated .google.devtools.cloudbuild.v1.Hash.HashType source_provenance_hash = 1;- Parameters:
values- The enum numeric values on the wire for sourceProvenanceHash to add.- Returns:
- This builder for chaining.
-
getRequestedVerifyOptionValue
public int getRequestedVerifyOptionValue()Requested verifiability options.
.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;- Specified by:
getRequestedVerifyOptionValuein interfaceBuildOptionsOrBuilder- Returns:
- The enum numeric value on the wire for requestedVerifyOption.
-
setRequestedVerifyOptionValue
Requested verifiability options.
.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;- Parameters:
value- The enum numeric value on the wire for requestedVerifyOption to set.- Returns:
- This builder for chaining.
-
getRequestedVerifyOption
Requested verifiability options.
.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;- Specified by:
getRequestedVerifyOptionin interfaceBuildOptionsOrBuilder- Returns:
- The requestedVerifyOption.
-
setRequestedVerifyOption
Requested verifiability options.
.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;- Parameters:
value- The requestedVerifyOption to set.- Returns:
- This builder for chaining.
-
clearRequestedVerifyOption
Requested verifiability options.
.google.devtools.cloudbuild.v1.BuildOptions.VerifyOption requested_verify_option = 2;- Returns:
- This builder for chaining.
-
getMachineTypeValue
public int getMachineTypeValue()Compute Engine machine type on which to run the build.
.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;- Specified by:
getMachineTypeValuein interfaceBuildOptionsOrBuilder- Returns:
- The enum numeric value on the wire for machineType.
-
setMachineTypeValue
Compute Engine machine type on which to run the build.
.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;- Parameters:
value- The enum numeric value on the wire for machineType to set.- Returns:
- This builder for chaining.
-
getMachineType
Compute Engine machine type on which to run the build.
.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;- Specified by:
getMachineTypein interfaceBuildOptionsOrBuilder- Returns:
- The machineType.
-
setMachineType
Compute Engine machine type on which to run the build.
.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;- Parameters:
value- The machineType to set.- Returns:
- This builder for chaining.
-
clearMachineType
Compute Engine machine type on which to run the build.
.google.devtools.cloudbuild.v1.BuildOptions.MachineType machine_type = 3;- Returns:
- This builder for chaining.
-
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 4000GB; builds that request more than the maximum are rejected with an error.
int64 disk_size_gb = 6;- Specified by:
getDiskSizeGbin interfaceBuildOptionsOrBuilder- Returns:
- The diskSizeGb.
-
setDiskSizeGb
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 4000GB; builds that request more than the maximum are rejected with an error.
int64 disk_size_gb = 6;- Parameters:
value- The diskSizeGb to set.- Returns:
- This builder for chaining.
-
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 4000GB; builds that request more than the maximum are rejected with an error.
int64 disk_size_gb = 6;- Returns:
- This builder for chaining.
-
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;- Specified by:
getSubstitutionOptionValuein interfaceBuildOptionsOrBuilder- Returns:
- The enum numeric value on the wire for substitutionOption.
-
setSubstitutionOptionValue
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;- Parameters:
value- The enum numeric value on the wire for substitutionOption to set.- Returns:
- This builder for chaining.
-
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;- Specified by:
getSubstitutionOptionin interfaceBuildOptionsOrBuilder- Returns:
- The substitutionOption.
-
setSubstitutionOption
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;- Parameters:
value- The substitutionOption to set.- Returns:
- This builder for chaining.
-
clearSubstitutionOption
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;- Returns:
- This builder for chaining.
-
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;- Specified by:
getDynamicSubstitutionsin interfaceBuildOptionsOrBuilder- Returns:
- The dynamicSubstitutions.
-
setDynamicSubstitutions
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;- Parameters:
value- The dynamicSubstitutions to set.- Returns:
- This builder for chaining.
-
clearDynamicSubstitutions
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;- Returns:
- This builder for chaining.
-
getAutomapSubstitutions
public boolean getAutomapSubstitutions()Option to include built-in and custom substitutions as env variables for all build steps.
bool automap_substitutions = 22;- Specified by:
getAutomapSubstitutionsin interfaceBuildOptionsOrBuilder- Returns:
- The automapSubstitutions.
-
setAutomapSubstitutions
Option to include built-in and custom substitutions as env variables for all build steps.
bool automap_substitutions = 22;- Parameters:
value- The automapSubstitutions to set.- Returns:
- This builder for chaining.
-
clearAutomapSubstitutions
Option to include built-in and custom substitutions as env variables for all build steps.
bool automap_substitutions = 22;- Returns:
- This builder for chaining.
-
getLogStreamingOptionValue
public int getLogStreamingOptionValue()Option to define build log streaming behavior to Cloud Storage.
.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;- Specified by:
getLogStreamingOptionValuein interfaceBuildOptionsOrBuilder- Returns:
- The enum numeric value on the wire for logStreamingOption.
-
setLogStreamingOptionValue
Option to define build log streaming behavior to Cloud Storage.
.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;- Parameters:
value- The enum numeric value on the wire for logStreamingOption to set.- Returns:
- This builder for chaining.
-
getLogStreamingOption
Option to define build log streaming behavior to Cloud Storage.
.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;- Specified by:
getLogStreamingOptionin interfaceBuildOptionsOrBuilder- Returns:
- The logStreamingOption.
-
setLogStreamingOption
Option to define build log streaming behavior to Cloud Storage.
.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;- Parameters:
value- The logStreamingOption to set.- Returns:
- This builder for chaining.
-
clearLogStreamingOption
Option to define build log streaming behavior to Cloud Storage.
.google.devtools.cloudbuild.v1.BuildOptions.LogStreamingOption log_streaming_option = 5;- Returns:
- This builder for chaining.
-
getWorkerPool
Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=2569This field deprecated; please use `pool.name` instead.
string worker_pool = 7 [deprecated = true];- Specified by:
getWorkerPoolin interfaceBuildOptionsOrBuilder- Returns:
- The workerPool.
-
getWorkerPoolBytes
Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=2569This field deprecated; please use `pool.name` instead.
string worker_pool = 7 [deprecated = true];- Specified by:
getWorkerPoolBytesin interfaceBuildOptionsOrBuilder- Returns:
- The bytes for workerPool.
-
setWorkerPool
Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=2569This field deprecated; please use `pool.name` instead.
string worker_pool = 7 [deprecated = true];- Parameters:
value- The workerPool to set.- Returns:
- This builder for chaining.
-
clearWorkerPool
Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=2569This field deprecated; please use `pool.name` instead.
string worker_pool = 7 [deprecated = true];- Returns:
- This builder for chaining.
-
setWorkerPoolBytes
Deprecated.google.devtools.cloudbuild.v1.BuildOptions.worker_pool is deprecated. See google/devtools/cloudbuild/v1/cloudbuild.proto;l=2569This field deprecated; please use `pool.name` instead.
string worker_pool = 7 [deprecated = true];- Parameters:
value- The bytes for workerPool to set.- Returns:
- This builder for chaining.
-
hasPool
public 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];- Specified by:
hasPoolin interfaceBuildOptionsOrBuilder- Returns:
- Whether the pool field is set.
-
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];- Specified by:
getPoolin interfaceBuildOptionsOrBuilder- Returns:
- The pool.
-
setPool
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]; -
setPool
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]; -
mergePool
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]; -
clearPool
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]; -
getPoolBuilder
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]; -
getPoolOrBuilder
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];- Specified by:
getPoolOrBuilderin interfaceBuildOptionsOrBuilder
-
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;- Specified by:
getLoggingValuein interfaceBuildOptionsOrBuilder- Returns:
- The enum numeric value on the wire for logging.
-
setLoggingValue
Option to specify the logging mode, which determines if and where build logs are stored.
.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;- Parameters:
value- The enum numeric value on the wire for logging to set.- Returns:
- This builder for chaining.
-
getLogging
Option to specify the logging mode, which determines if and where build logs are stored.
.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;- Specified by:
getLoggingin interfaceBuildOptionsOrBuilder- Returns:
- The logging.
-
setLogging
Option to specify the logging mode, which determines if and where build logs are stored.
.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;- Parameters:
value- The logging to set.- Returns:
- This builder for chaining.
-
clearLogging
Option to specify the logging mode, which determines if and where build logs are stored.
.google.devtools.cloudbuild.v1.BuildOptions.LoggingMode logging = 11;- Returns:
- This builder for chaining.
-
getEnvList
public com.google.protobuf.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;- Specified by:
getEnvListin interfaceBuildOptionsOrBuilder- Returns:
- A list containing the env.
-
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;- Specified by:
getEnvCountin interfaceBuildOptionsOrBuilder- Returns:
- The count of env.
-
getEnv
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;- Specified by:
getEnvin interfaceBuildOptionsOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The env at the given index.
-
getEnvBytes
public com.google.protobuf.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;- Specified by:
getEnvBytesin interfaceBuildOptionsOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the env at the given index.
-
setEnv
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:
index- The index to set the value at.value- The env to set.- Returns:
- This builder for chaining.
-
addEnv
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:
value- The env to add.- Returns:
- This builder for chaining.
-
addAllEnv
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:
values- The env to add.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
addEnvBytes
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:
value- The bytes of the env to add.- Returns:
- This builder for chaining.
-
getSecretEnvList
public com.google.protobuf.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;- Specified by:
getSecretEnvListin interfaceBuildOptionsOrBuilder- Returns:
- A list containing the secretEnv.
-
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;- Specified by:
getSecretEnvCountin interfaceBuildOptionsOrBuilder- Returns:
- The count of secretEnv.
-
getSecretEnv
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;- Specified by:
getSecretEnvin interfaceBuildOptionsOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The secretEnv at the given index.
-
getSecretEnvBytes
public com.google.protobuf.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;- Specified by:
getSecretEnvBytesin interfaceBuildOptionsOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the secretEnv at the given index.
-
setSecretEnv
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:
index- The index to set the value at.value- The secretEnv to set.- Returns:
- This builder for chaining.
-
addSecretEnv
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:
value- The secretEnv to add.- Returns:
- This builder for chaining.
-
addAllSecretEnv
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:
values- The secretEnv to add.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
addSecretEnvBytes
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:
value- The bytes of the secretEnv to add.- Returns:
- This builder for chaining.
-
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;- Specified by:
getVolumesListin interfaceBuildOptionsOrBuilder
-
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;- Specified by:
getVolumesCountin interfaceBuildOptionsOrBuilder
-
getVolumes
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;- Specified by:
getVolumesin interfaceBuildOptionsOrBuilder
-
setVolumes
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; -
setVolumes
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; -
addVolumes
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; -
addVolumes
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; -
addVolumes
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; -
addVolumes
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; -
addAllVolumes
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; -
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.devtools.cloudbuild.v1.Volume volumes = 14; -
removeVolumes
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; -
getVolumesBuilder
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
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;- Specified by:
getVolumesOrBuilderin interfaceBuildOptionsOrBuilder
-
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;- Specified by:
getVolumesOrBuilderListin interfaceBuildOptionsOrBuilder
-
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.devtools.cloudbuild.v1.Volume volumes = 14; -
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.devtools.cloudbuild.v1.Volume volumes = 14; -
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.devtools.cloudbuild.v1.Volume volumes = 14; -
getDefaultLogsBucketBehaviorValue
public 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];- Specified by:
getDefaultLogsBucketBehaviorValuein interfaceBuildOptionsOrBuilder- Returns:
- The enum numeric value on the wire for defaultLogsBucketBehavior.
-
setDefaultLogsBucketBehaviorValue
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];- Parameters:
value- The enum numeric value on the wire for defaultLogsBucketBehavior to set.- Returns:
- This builder for chaining.
-
getDefaultLogsBucketBehavior
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];- Specified by:
getDefaultLogsBucketBehaviorin interfaceBuildOptionsOrBuilder- Returns:
- The defaultLogsBucketBehavior.
-
setDefaultLogsBucketBehavior
public BuildOptions.Builder setDefaultLogsBucketBehavior(BuildOptions.DefaultLogsBucketBehavior value) 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];- Parameters:
value- The defaultLogsBucketBehavior to set.- Returns:
- This builder for chaining.
-
clearDefaultLogsBucketBehavior
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];- Returns:
- This builder for chaining.
-
getEnableStructuredLogging
public boolean getEnableStructuredLogging()Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
bool enable_structured_logging = 23 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getEnableStructuredLoggingin interfaceBuildOptionsOrBuilder- Returns:
- The enableStructuredLogging.
-
setEnableStructuredLogging
Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
bool enable_structured_logging = 23 [(.google.api.field_behavior) = OPTIONAL];- Parameters:
value- The enableStructuredLogging to set.- Returns:
- This builder for chaining.
-
clearEnableStructuredLogging
Optional. Option to specify whether structured logging is enabled. If true, JSON-formatted logs are parsed as structured logs.
bool enable_structured_logging = 23 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- This builder for chaining.
-