Class BuildConfig.Builder (2.13.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.77.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.72.0
- 2.70.0
- 2.69.0
- 2.66.0
- 2.65.0
- 2.64.0
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.4
- 2.4.3
- 2.3.6
publicstaticfinalclass BuildConfig.BuilderextendsGeneratedMessageV3.Builder<BuildConfig.Builder>implementsBuildConfigOrBuilderDescribes the Build step of the function that builds a container from the given source.
Protobuf type google.cloud.functions.v2alpha.BuildConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BuildConfig.BuilderImplements
BuildConfigOrBuilderInherited Members
Static Methods
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
publicBuildConfig.BuilderaddRepeatedField(Descriptors.FieldDescriptorfield,Objectvalue)build()
publicBuildConfigbuild()buildPartial()
publicBuildConfigbuildPartial()clear()
publicBuildConfig.Builderclear()clearBuild()
publicBuildConfig.BuilderclearBuild()Output only. The Cloud Build name of the latest successful deployment of the function.
string build = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
clearDockerRepository()
publicBuildConfig.BuilderclearDockerRepository() Optional. User managed repository created in Artifact Registry optionally with a
customer managed encryption key. This is the repository to which the
function docker image will be pushed after it is built by Cloud Build.
If unspecified, GCF will create and use a repository named 'gcf-artifacts'
for every deployed region.
It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}.
Cross-project repositories are not supported.
Cross-location repositories are not supported.
Repository format must be 'DOCKER'.
string docker_repository = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
clearEntryPoint()
publicBuildConfig.BuilderclearEntryPoint() The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
string entry_point = 3;
BuildConfig.Builder
This builder for chaining.
clearEnvironmentVariables()
publicBuildConfig.BuilderclearEnvironmentVariables()clearField(Descriptors.FieldDescriptor field)
publicBuildConfig.BuilderclearField(Descriptors.FieldDescriptorfield)clearOneof(Descriptors.OneofDescriptor oneof)
publicBuildConfig.BuilderclearOneof(Descriptors.OneofDescriptoroneof)clearRuntime()
publicBuildConfig.BuilderclearRuntime() The runtime in which to run the function. Required when deploying a new
function, optional when updating an existing function. For a complete
list of possible choices, see the
gcloud command
reference.
string runtime = 2;
BuildConfig.Builder
This builder for chaining.
clearSource()
publicBuildConfig.BuilderclearSource()The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
clearSourceProvenance()
publicBuildConfig.BuilderclearSourceProvenance()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
clearWorkerPool()
publicBuildConfig.BuilderclearWorkerPool() Name of the Cloud Build Custom Worker Pool that should be used to build the
function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool} where
{project} and {region} are the project id and region respectively where the
worker pool is defined and {workerPool} is the short name of the worker
pool.
If the project id is not the same as the function, then the Cloud
Functions Service Agent
(service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be
granted the role Cloud Build Custom Workers Builder
(roles/cloudbuild.customworkers.builder) in the project.
string worker_pool = 5 [(.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
clone()
publicBuildConfig.Builderclone()containsEnvironmentVariables(String key)
publicbooleancontainsEnvironmentVariables(Stringkey)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getBuild()
publicStringgetBuild()Output only. The Cloud Build name of the latest successful deployment of the function.
string build = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
String
The build.
getBuildBytes()
publicByteStringgetBuildBytes()Output only. The Cloud Build name of the latest successful deployment of the function.
string build = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
ByteString
The bytes for build.
getDefaultInstanceForType()
publicBuildConfiggetDefaultInstanceForType()getDescriptorForType()
publicDescriptors.DescriptorgetDescriptorForType()getDockerRepository()
publicStringgetDockerRepository() Optional. User managed repository created in Artifact Registry optionally with a
customer managed encryption key. This is the repository to which the
function docker image will be pushed after it is built by Cloud Build.
If unspecified, GCF will create and use a repository named 'gcf-artifacts'
for every deployed region.
It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}.
Cross-project repositories are not supported.
Cross-location repositories are not supported.
Repository format must be 'DOCKER'.
string docker_repository = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
String
The dockerRepository.
getDockerRepositoryBytes()
publicByteStringgetDockerRepositoryBytes() Optional. User managed repository created in Artifact Registry optionally with a
customer managed encryption key. This is the repository to which the
function docker image will be pushed after it is built by Cloud Build.
If unspecified, GCF will create and use a repository named 'gcf-artifacts'
for every deployed region.
It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}.
Cross-project repositories are not supported.
Cross-location repositories are not supported.
Repository format must be 'DOCKER'.
string docker_repository = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
ByteString
The bytes for dockerRepository.
getEntryPoint()
publicStringgetEntryPoint() The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
string entry_point = 3;
String
The entryPoint.
getEntryPointBytes()
publicByteStringgetEntryPointBytes() The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
string entry_point = 3;
ByteString
The bytes for entryPoint.
getEnvironmentVariables()
publicMap<String,String>getEnvironmentVariables()Use #getEnvironmentVariablesMap() instead.
getEnvironmentVariablesCount()
publicintgetEnvironmentVariablesCount()User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getEnvironmentVariablesMap()
publicMap<String,String>getEnvironmentVariablesMap()User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getEnvironmentVariablesOrDefault(String key, String defaultValue)
publicStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getEnvironmentVariablesOrThrow(String key)
publicStringgetEnvironmentVariablesOrThrow(Stringkey)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
getMutableEnvironmentVariables()
publicMap<String,String>getMutableEnvironmentVariables()Use alternate mutation accessors instead.
getRuntime()
publicStringgetRuntime() The runtime in which to run the function. Required when deploying a new
function, optional when updating an existing function. For a complete
list of possible choices, see the
gcloud command
reference.
string runtime = 2;
String
The runtime.
getRuntimeBytes()
publicByteStringgetRuntimeBytes() The runtime in which to run the function. Required when deploying a new
function, optional when updating an existing function. For a complete
list of possible choices, see the
gcloud command
reference.
string runtime = 2;
ByteString
The bytes for runtime.
getSource()
publicSourcegetSource()The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
Source
The source.
getSourceBuilder()
publicSource.BuildergetSourceBuilder()The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
getSourceOrBuilder()
publicSourceOrBuildergetSourceOrBuilder()The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
getSourceProvenance()
publicSourceProvenancegetSourceProvenance()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
SourceProvenance
The sourceProvenance.
getSourceProvenanceBuilder()
publicSourceProvenance.BuildergetSourceProvenanceBuilder()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getSourceProvenanceOrBuilder()
publicSourceProvenanceOrBuildergetSourceProvenanceOrBuilder()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
getWorkerPool()
publicStringgetWorkerPool() Name of the Cloud Build Custom Worker Pool that should be used to build the
function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool} where
{project} and {region} are the project id and region respectively where the
worker pool is defined and {workerPool} is the short name of the worker
pool.
If the project id is not the same as the function, then the Cloud
Functions Service Agent
(service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be
granted the role Cloud Build Custom Workers Builder
(roles/cloudbuild.customworkers.builder) in the project.
string worker_pool = 5 [(.google.api.resource_reference) = { ... }
String
The workerPool.
getWorkerPoolBytes()
publicByteStringgetWorkerPoolBytes() Name of the Cloud Build Custom Worker Pool that should be used to build the
function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool} where
{project} and {region} are the project id and region respectively where the
worker pool is defined and {workerPool} is the short name of the worker
pool.
If the project id is not the same as the function, then the Cloud
Functions Service Agent
(service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be
granted the role Cloud Build Custom Workers Builder
(roles/cloudbuild.customworkers.builder) in the project.
string worker_pool = 5 [(.google.api.resource_reference) = { ... }
ByteString
The bytes for workerPool.
hasSource()
publicbooleanhasSource()The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
boolean
Whether the source field is set.
hasSourceProvenance()
publicbooleanhasSourceProvenance()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
boolean
Whether the sourceProvenance field is set.
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()internalGetMapField(int number)
protectedMapFieldinternalGetMapField(intnumber)internalGetMutableMapField(int number)
protectedMapFieldinternalGetMutableMapField(intnumber)isInitialized()
publicfinalbooleanisInitialized()mergeFrom(BuildConfig other)
publicBuildConfig.BuildermergeFrom(BuildConfigother)mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicBuildConfig.BuildermergeFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)mergeFrom(Message other)
publicBuildConfig.BuildermergeFrom(Messageother)mergeSource(Source value)
publicBuildConfig.BuildermergeSource(Sourcevalue)The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
mergeSourceProvenance(SourceProvenance value)
publicBuildConfig.BuildermergeSourceProvenance(SourceProvenancevalue)Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
mergeUnknownFields(UnknownFieldSet unknownFields)
publicfinalBuildConfig.BuildermergeUnknownFields(UnknownFieldSetunknownFields)putAllEnvironmentVariables(Map<String,String> values)
publicBuildConfig.BuilderputAllEnvironmentVariables(Map<String,String>values)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
putEnvironmentVariables(String key, String value)
publicBuildConfig.BuilderputEnvironmentVariables(Stringkey,Stringvalue)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
removeEnvironmentVariables(String key)
publicBuildConfig.BuilderremoveEnvironmentVariables(Stringkey)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
setBuild(String value)
publicBuildConfig.BuildersetBuild(Stringvalue)Output only. The Cloud Build name of the latest successful deployment of the function.
string build = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
setBuildBytes(ByteString value)
publicBuildConfig.BuildersetBuildBytes(ByteStringvalue)Output only. The Cloud Build name of the latest successful deployment of the function.
string build = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
setDockerRepository(String value)
publicBuildConfig.BuildersetDockerRepository(Stringvalue) Optional. User managed repository created in Artifact Registry optionally with a
customer managed encryption key. This is the repository to which the
function docker image will be pushed after it is built by Cloud Build.
If unspecified, GCF will create and use a repository named 'gcf-artifacts'
for every deployed region.
It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}.
Cross-project repositories are not supported.
Cross-location repositories are not supported.
Repository format must be 'DOCKER'.
string docker_repository = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
setDockerRepositoryBytes(ByteString value)
publicBuildConfig.BuildersetDockerRepositoryBytes(ByteStringvalue) Optional. User managed repository created in Artifact Registry optionally with a
customer managed encryption key. This is the repository to which the
function docker image will be pushed after it is built by Cloud Build.
If unspecified, GCF will create and use a repository named 'gcf-artifacts'
for every deployed region.
It must match the pattern
projects/{project}/locations/{location}/repositories/{repository}.
Cross-project repositories are not supported.
Cross-location repositories are not supported.
Repository format must be 'DOCKER'.
string docker_repository = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
setEntryPoint(String value)
publicBuildConfig.BuildersetEntryPoint(Stringvalue) The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
string entry_point = 3;
BuildConfig.Builder
This builder for chaining.
setEntryPointBytes(ByteString value)
publicBuildConfig.BuildersetEntryPointBytes(ByteStringvalue) The name of the function (as defined in source code) that will be
executed. Defaults to the resource name suffix, if not specified. For
backward compatibility, if function with given name is not found, then the
system will try to use function named "function".
For Node.js this is name of a function exported by the module specified
in source_location.
string entry_point = 3;
BuildConfig.Builder
This builder for chaining.
setField(Descriptors.FieldDescriptor field, Object value)
publicBuildConfig.BuildersetField(Descriptors.FieldDescriptorfield,Objectvalue)setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
publicBuildConfig.BuildersetRepeatedField(Descriptors.FieldDescriptorfield,intindex,Objectvalue)setRuntime(String value)
publicBuildConfig.BuildersetRuntime(Stringvalue) The runtime in which to run the function. Required when deploying a new
function, optional when updating an existing function. For a complete
list of possible choices, see the
gcloud command
reference.
string runtime = 2;
BuildConfig.Builder
This builder for chaining.
setRuntimeBytes(ByteString value)
publicBuildConfig.BuildersetRuntimeBytes(ByteStringvalue) The runtime in which to run the function. Required when deploying a new
function, optional when updating an existing function. For a complete
list of possible choices, see the
gcloud command
reference.
string runtime = 2;
BuildConfig.Builder
This builder for chaining.
setSource(Source value)
publicBuildConfig.BuildersetSource(Sourcevalue)The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
setSource(Source.Builder builderForValue)
publicBuildConfig.BuildersetSource(Source.BuilderbuilderForValue)The location of the function source code.
.google.cloud.functions.v2alpha.Source source = 4;
setSourceProvenance(SourceProvenance value)
publicBuildConfig.BuildersetSourceProvenance(SourceProvenancevalue)Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
setSourceProvenance(SourceProvenance.Builder builderForValue)
publicBuildConfig.BuildersetSourceProvenance(SourceProvenance.BuilderbuilderForValue)Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2alpha.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
setUnknownFields(UnknownFieldSet unknownFields)
publicfinalBuildConfig.BuildersetUnknownFields(UnknownFieldSetunknownFields)setWorkerPool(String value)
publicBuildConfig.BuildersetWorkerPool(Stringvalue) Name of the Cloud Build Custom Worker Pool that should be used to build the
function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool} where
{project} and {region} are the project id and region respectively where the
worker pool is defined and {workerPool} is the short name of the worker
pool.
If the project id is not the same as the function, then the Cloud
Functions Service Agent
(service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be
granted the role Cloud Build Custom Workers Builder
(roles/cloudbuild.customworkers.builder) in the project.
string worker_pool = 5 [(.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.
setWorkerPoolBytes(ByteString value)
publicBuildConfig.BuildersetWorkerPoolBytes(ByteStringvalue) Name of the Cloud Build Custom Worker Pool that should be used to build the
function. The format of this field is
projects/{project}/locations/{region}/workerPools/{workerPool} where
{project} and {region} are the project id and region respectively where the
worker pool is defined and {workerPool} is the short name of the worker
pool.
If the project id is not the same as the function, then the Cloud
Functions Service Agent
(service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be
granted the role Cloud Build Custom Workers Builder
(roles/cloudbuild.customworkers.builder) in the project.
string worker_pool = 5 [(.google.api.resource_reference) = { ... }
BuildConfig.Builder
This builder for chaining.