- 2.62.0 (latest)
- 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
publicinterfaceBuildConfigOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsEnvironmentVariables(String key)
publicabstractbooleancontainsEnvironmentVariables(Stringkey)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAutomaticUpdatePolicy()
publicabstractAutomaticUpdatePolicygetAutomaticUpdatePolicy().google.cloud.functions.v2.AutomaticUpdatePolicy automatic_update_policy = 40;
| Returns | |
|---|---|
| Type | Description |
AutomaticUpdatePolicy | The automaticUpdatePolicy. |
getAutomaticUpdatePolicyOrBuilder()
publicabstractAutomaticUpdatePolicyOrBuildergetAutomaticUpdatePolicyOrBuilder().google.cloud.functions.v2.AutomaticUpdatePolicy automatic_update_policy = 40;
| Returns | |
|---|---|
| Type | Description |
AutomaticUpdatePolicyOrBuilder | |
getBuild()
publicabstractStringgetBuild()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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The build. |
getBuildBytes()
publicabstractByteStringgetBuildBytes()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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for build. |
getDockerRegistry()
publicabstractBuildConfig.DockerRegistrygetDockerRegistry()Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry.
If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.
.google.cloud.functions.v2.BuildConfig.DockerRegistry docker_registry = 10;
| Returns | |
|---|---|
| Type | Description |
BuildConfig.DockerRegistry | The dockerRegistry. |
getDockerRegistryValue()
publicabstractintgetDockerRegistryValue()Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry.
If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.
.google.cloud.functions.v2.BuildConfig.DockerRegistry docker_registry = 10;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for dockerRegistry. |
getDockerRepository()
publicabstractStringgetDockerRepository()Repository in Artifact Registry to which the function docker image will be pushed after it is built by Cloud Build. If specified by user, it is created and managed by user with a customer managed encryption key. Otherwise, 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.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The dockerRepository. |
getDockerRepositoryBytes()
publicabstractByteStringgetDockerRepositoryBytes()Repository in Artifact Registry to which the function docker image will be pushed after it is built by Cloud Build. If specified by user, it is created and managed by user with a customer managed encryption key. Otherwise, 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.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for dockerRepository. |
getEntryPoint()
publicabstractStringgetEntryPoint() 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;
| Returns | |
|---|---|
| Type | Description |
String | The entryPoint. |
getEntryPointBytes()
publicabstractByteStringgetEntryPointBytes() 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for entryPoint. |
getEnvironmentVariables() (deprecated)
publicabstractMap<String,String>getEnvironmentVariables()Use #getEnvironmentVariablesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getEnvironmentVariablesCount()
publicabstractintgetEnvironmentVariablesCount()User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
| Returns | |
|---|---|
| Type | Description |
int | |
getEnvironmentVariablesMap()
publicabstractMap<String,String>getEnvironmentVariablesMap()User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getEnvironmentVariablesOrDefault(String key, String defaultValue)
publicabstractStringgetEnvironmentVariablesOrDefault(Stringkey,StringdefaultValue)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getEnvironmentVariablesOrThrow(String key)
publicabstractStringgetEnvironmentVariablesOrThrow(Stringkey)User-provided build-time environment variables for the function
map<string, string> environment_variables = 6;
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getOnDeployUpdatePolicy()
publicabstractOnDeployUpdatePolicygetOnDeployUpdatePolicy().google.cloud.functions.v2.OnDeployUpdatePolicy on_deploy_update_policy = 41;
| Returns | |
|---|---|
| Type | Description |
OnDeployUpdatePolicy | The onDeployUpdatePolicy. |
getOnDeployUpdatePolicyOrBuilder()
publicabstractOnDeployUpdatePolicyOrBuildergetOnDeployUpdatePolicyOrBuilder().google.cloud.functions.v2.OnDeployUpdatePolicy on_deploy_update_policy = 41;
| Returns | |
|---|---|
| Type | Description |
OnDeployUpdatePolicyOrBuilder | |
getRuntime()
publicabstractStringgetRuntime() 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;
| Returns | |
|---|---|
| Type | Description |
String | The runtime. |
getRuntimeBytes()
publicabstractByteStringgetRuntimeBytes() 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for runtime. |
getRuntimeUpdatePolicyCase()
publicabstractBuildConfig.RuntimeUpdatePolicyCasegetRuntimeUpdatePolicyCase()| Returns | |
|---|---|
| Type | Description |
BuildConfig.RuntimeUpdatePolicyCase | |
getServiceAccount()
publicabstractStringgetServiceAccount() Service account to be used for building the container. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.
string service_account = 27;
| Returns | |
|---|---|
| Type | Description |
String | The serviceAccount. |
getServiceAccountBytes()
publicabstractByteStringgetServiceAccountBytes() Service account to be used for building the container. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.
string service_account = 27;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for serviceAccount. |
getSource()
publicabstractSourcegetSource()The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
| Returns | |
|---|---|
| Type | Description |
Source | The source. |
getSourceOrBuilder()
publicabstractSourceOrBuildergetSourceOrBuilder()The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
| Returns | |
|---|---|
| Type | Description |
SourceOrBuilder | |
getSourceProvenance()
publicabstractSourceProvenancegetSourceProvenance()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SourceProvenance | The sourceProvenance. |
getSourceProvenanceOrBuilder()
publicabstractSourceProvenanceOrBuildergetSourceProvenanceOrBuilder()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SourceProvenanceOrBuilder | |
getWorkerPool()
publicabstractStringgetWorkerPool() 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The workerPool. |
getWorkerPoolBytes()
publicabstractByteStringgetWorkerPoolBytes() 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) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for workerPool. |
hasAutomaticUpdatePolicy()
publicabstractbooleanhasAutomaticUpdatePolicy().google.cloud.functions.v2.AutomaticUpdatePolicy automatic_update_policy = 40;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the automaticUpdatePolicy field is set. |
hasOnDeployUpdatePolicy()
publicabstractbooleanhasOnDeployUpdatePolicy().google.cloud.functions.v2.OnDeployUpdatePolicy on_deploy_update_policy = 41;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the onDeployUpdatePolicy field is set. |
hasSource()
publicabstractbooleanhasSource()The location of the function source code.
.google.cloud.functions.v2.Source source = 4;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the source field is set. |
hasSourceProvenance()
publicabstractbooleanhasSourceProvenance()Output only. A permanent fixed identifier for source.
.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sourceProvenance field is set. |
