- 2.49.0 (latest)
- 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
public static final class BuildConfig.Builder extends GeneratedMessageV3.Builder<BuildConfig.Builder> implements BuildConfigOrBuilder
Describes the Build step of the function that builds a container from the given source.
Protobuf type google.cloud.functions.v2.BuildConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BuildConfig.BuilderImplements
BuildConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BuildConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
BuildConfig.Builder |
build()
public BuildConfig build()
Type | Description |
BuildConfig |
buildPartial()
public BuildConfig buildPartial()
Type | Description |
BuildConfig |
clear()
public BuildConfig.Builder clear()
Type | Description |
BuildConfig.Builder |
clearBuild()
public BuildConfig.Builder clearBuild()
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) = { ... }
Type | Description |
BuildConfig.Builder | This builder for chaining. |
clearDockerRepository()
public BuildConfig.Builder clearDockerRepository()
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) = { ... }
Type | Description |
BuildConfig.Builder | This builder for chaining. |
clearEntryPoint()
public BuildConfig.Builder clearEntryPoint()
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;
Type | Description |
BuildConfig.Builder | This builder for chaining. |
clearEnvironmentVariables()
public BuildConfig.Builder clearEnvironmentVariables()
Type | Description |
BuildConfig.Builder |
clearField(Descriptors.FieldDescriptor field)
public BuildConfig.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
BuildConfig.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public BuildConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
BuildConfig.Builder |
clearRuntime()
public BuildConfig.Builder clearRuntime()
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;
Type | Description |
BuildConfig.Builder | This builder for chaining. |
clearSource()
public BuildConfig.Builder clearSource()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Type | Description |
BuildConfig.Builder |
clearSourceProvenance()
public BuildConfig.Builder clearSourceProvenance()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
BuildConfig.Builder |
clearWorkerPool()
public BuildConfig.Builder clearWorkerPool()
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) = { ... }
Type | Description |
BuildConfig.Builder | This builder for chaining. |
clone()
public BuildConfig.Builder clone()
Type | Description |
BuildConfig.Builder |
containsEnvironmentVariables(String key)
public boolean containsEnvironmentVariables(String key)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Name | Description |
key | String |
Type | Description |
boolean |
getBuild()
public String getBuild()
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) = { ... }
Type | Description |
String | The build. |
getBuildBytes()
public ByteString getBuildBytes()
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) = { ... }
Type | Description |
ByteString | The bytes for build. |
getDefaultInstanceForType()
public BuildConfig getDefaultInstanceForType()
Type | Description |
BuildConfig |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getDockerRepository()
public String getDockerRepository()
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) = { ... }
Type | Description |
String | The dockerRepository. |
getDockerRepositoryBytes()
public ByteString getDockerRepositoryBytes()
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) = { ... }
Type | Description |
ByteString | The bytes for dockerRepository. |
getEntryPoint()
public String getEntryPoint()
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;
Type | Description |
String | The entryPoint. |
getEntryPointBytes()
public ByteString getEntryPointBytes()
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;
Type | Description |
ByteString | The bytes for entryPoint. |
getEnvironmentVariables()
public Map<String,String> getEnvironmentVariables()
Use #getEnvironmentVariablesMap() instead.
Type | Description |
Map<String,String> |
getEnvironmentVariablesCount()
public int getEnvironmentVariablesCount()
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Type | Description |
int |
getEnvironmentVariablesMap()
public Map<String,String> getEnvironmentVariablesMap()
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Type | Description |
Map<String,String> |
getEnvironmentVariablesOrDefault(String key, String defaultValue)
public String getEnvironmentVariablesOrDefault(String key, String defaultValue)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Name | Description |
key | String |
defaultValue | String |
Type | Description |
String |
getEnvironmentVariablesOrThrow(String key)
public String getEnvironmentVariablesOrThrow(String key)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Name | Description |
key | String |
Type | Description |
String |
getMutableEnvironmentVariables()
public Map<String,String> getMutableEnvironmentVariables()
Use alternate mutation accessors instead.
Type | Description |
Map<String,String> |
getRuntime()
public String getRuntime()
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;
Type | Description |
String | The runtime. |
getRuntimeBytes()
public ByteString getRuntimeBytes()
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;
Type | Description |
ByteString | The bytes for runtime. |
getSource()
public Source getSource()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Type | Description |
Source | The source. |
getSourceBuilder()
public Source.Builder getSourceBuilder()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Type | Description |
Source.Builder |
getSourceOrBuilder()
public SourceOrBuilder getSourceOrBuilder()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Type | Description |
SourceOrBuilder |
getSourceProvenance()
public SourceProvenance getSourceProvenance()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
SourceProvenance | The sourceProvenance. |
getSourceProvenanceBuilder()
public SourceProvenance.Builder getSourceProvenanceBuilder()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
SourceProvenance.Builder |
getSourceProvenanceOrBuilder()
public SourceProvenanceOrBuilder getSourceProvenanceOrBuilder()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
SourceProvenanceOrBuilder |
getWorkerPool()
public String getWorkerPool()
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) = { ... }
Type | Description |
String | The workerPool. |
getWorkerPoolBytes()
public ByteString getWorkerPoolBytes()
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) = { ... }
Type | Description |
ByteString | The bytes for workerPool. |
hasSource()
public boolean hasSource()
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Type | Description |
boolean | Whether the source field is set. |
hasSourceProvenance()
public boolean hasSourceProvenance()
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
boolean | Whether the sourceProvenance field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Name | Description |
number | int |
Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(BuildConfig other)
public BuildConfig.Builder mergeFrom(BuildConfig other)
Name | Description |
other | BuildConfig |
Type | Description |
BuildConfig.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BuildConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
BuildConfig.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public BuildConfig.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
BuildConfig.Builder |
mergeSource(Source value)
public BuildConfig.Builder mergeSource(Source value)
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Name | Description |
value | Source |
Type | Description |
BuildConfig.Builder |
mergeSourceProvenance(SourceProvenance value)
public BuildConfig.Builder mergeSourceProvenance(SourceProvenance value)
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Name | Description |
value | SourceProvenance |
Type | Description |
BuildConfig.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BuildConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
BuildConfig.Builder |
putAllEnvironmentVariables(Map<String,String> values)
public BuildConfig.Builder putAllEnvironmentVariables(Map<String,String> values)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Name | Description |
values | Map<String,String> |
Type | Description |
BuildConfig.Builder |
putEnvironmentVariables(String key, String value)
public BuildConfig.Builder putEnvironmentVariables(String key, String value)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Name | Description |
key | String |
value | String |
Type | Description |
BuildConfig.Builder |
removeEnvironmentVariables(String key)
public BuildConfig.Builder removeEnvironmentVariables(String key)
User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
Name | Description |
key | String |
Type | Description |
BuildConfig.Builder |
setBuild(String value)
public BuildConfig.Builder setBuild(String value)
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) = { ... }
Name | Description |
value | String The build to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setBuildBytes(ByteString value)
public BuildConfig.Builder setBuildBytes(ByteString value)
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) = { ... }
Name | Description |
value | ByteString The bytes for build to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setDockerRepository(String value)
public BuildConfig.Builder setDockerRepository(String value)
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) = { ... }
Name | Description |
value | String The dockerRepository to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setDockerRepositoryBytes(ByteString value)
public BuildConfig.Builder setDockerRepositoryBytes(ByteString value)
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) = { ... }
Name | Description |
value | ByteString The bytes for dockerRepository to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setEntryPoint(String value)
public BuildConfig.Builder setEntryPoint(String value)
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;
Name | Description |
value | String The entryPoint to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setEntryPointBytes(ByteString value)
public BuildConfig.Builder setEntryPointBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for entryPoint to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public BuildConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
BuildConfig.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BuildConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
BuildConfig.Builder |
setRuntime(String value)
public BuildConfig.Builder setRuntime(String value)
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;
Name | Description |
value | String The runtime to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setRuntimeBytes(ByteString value)
public BuildConfig.Builder setRuntimeBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for runtime to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setSource(Source value)
public BuildConfig.Builder setSource(Source value)
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Name | Description |
value | Source |
Type | Description |
BuildConfig.Builder |
setSource(Source.Builder builderForValue)
public BuildConfig.Builder setSource(Source.Builder builderForValue)
The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
Name | Description |
builderForValue | Source.Builder |
Type | Description |
BuildConfig.Builder |
setSourceProvenance(SourceProvenance value)
public BuildConfig.Builder setSourceProvenance(SourceProvenance value)
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Name | Description |
value | SourceProvenance |
Type | Description |
BuildConfig.Builder |
setSourceProvenance(SourceProvenance.Builder builderForValue)
public BuildConfig.Builder setSourceProvenance(SourceProvenance.Builder builderForValue)
Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Name | Description |
builderForValue | SourceProvenance.Builder |
Type | Description |
BuildConfig.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final BuildConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
BuildConfig.Builder |
setWorkerPool(String value)
public BuildConfig.Builder setWorkerPool(String value)
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) = { ... }
Name | Description |
value | String The workerPool to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |
setWorkerPoolBytes(ByteString value)
public BuildConfig.Builder setWorkerPoolBytes(ByteString value)
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) = { ... }
Name | Description |
value | ByteString The bytes for workerPool to set. |
Type | Description |
BuildConfig.Builder | This builder for chaining. |