com.google.cloud.functions.v2

Interface BuildConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

BuildConfig, BuildConfig.Builder

public interface BuildConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsEnvironmentVariables(String key) User-provided build-time environment variables for the function
String	getBuild() Output only.
com.google.protobuf.ByteString	getBuildBytes() Output only.
BuildConfig.DockerRegistry	getDockerRegistry() Docker Registry to use for this deployment.
int	getDockerRegistryValue() Docker Registry to use for this deployment.
String	getDockerRepository() User managed repository created in Artifact Registry optionally with a customer managed encryption key.
com.google.protobuf.ByteString	getDockerRepositoryBytes() User managed repository created in Artifact Registry optionally with a customer managed encryption key.
String	getEntryPoint() The name of the function (as defined in source code) that will be executed.
com.google.protobuf.ByteString	getEntryPointBytes() The name of the function (as defined in source code) that will be executed.
Map<String,String>	getEnvironmentVariables() Deprecated.
int	getEnvironmentVariablesCount() User-provided build-time environment variables for the function
Map<String,String>	getEnvironmentVariablesMap() User-provided build-time environment variables for the function
String	getEnvironmentVariablesOrDefault(String key, String defaultValue) User-provided build-time environment variables for the function
String	getEnvironmentVariablesOrThrow(String key) User-provided build-time environment variables for the function
String	getRuntime() The runtime in which to run the function.
com.google.protobuf.ByteString	getRuntimeBytes() The runtime in which to run the function.
Source	getSource() The location of the function source code.
SourceOrBuilder	getSourceOrBuilder() The location of the function source code.
SourceProvenance	getSourceProvenance() Output only.
SourceProvenanceOrBuilder	getSourceProvenanceOrBuilder() Output only.
String	getWorkerPool() Name of the Cloud Build Custom Worker Pool that should be used to build the function.
com.google.protobuf.ByteString	getWorkerPoolBytes() Name of the Cloud Build Custom Worker Pool that should be used to build the function.
boolean	hasSource() The location of the function source code.
boolean	hasSourceProvenance() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getBuild

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) = { ... }

Returns:

The build.

getBuildBytes

com.google.protobuf.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) = { ... }

Returns:

The bytes for build.

getRuntime

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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
 

string runtime = 2;

Returns:

The runtime.

getRuntimeBytes

com.google.protobuf.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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
 

string runtime = 2;

Returns:

The bytes for runtime.

getEntryPoint

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;

Returns:

The entryPoint.

getEntryPointBytes

com.google.protobuf.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;

Returns:

The bytes for entryPoint.

hasSource

boolean hasSource()

 The location of the function source code.
 

.google.cloud.functions.v2.Source source = 4;

Returns:

Whether the source field is set.

getSource

Source getSource()

 The location of the function source code.
 

.google.cloud.functions.v2.Source source = 4;

Returns:

The source.

getSourceOrBuilder

SourceOrBuilder getSourceOrBuilder()

 The location of the function source code.
 

.google.cloud.functions.v2.Source source = 4;

hasSourceProvenance

boolean hasSourceProvenance()

 Output only. A permanent fixed identifier for source.
 

.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the sourceProvenance field is set.

getSourceProvenance

SourceProvenance getSourceProvenance()

 Output only. A permanent fixed identifier for source.
 

.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The sourceProvenance.

getSourceProvenanceOrBuilder

SourceProvenanceOrBuilder getSourceProvenanceOrBuilder()

 Output only. A permanent fixed identifier for source.
 

.google.cloud.functions.v2.SourceProvenance source_provenance = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getWorkerPool

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) = { ... }

Returns:

The workerPool.

getWorkerPoolBytes

com.google.protobuf.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) = { ... }

Returns:

The bytes for workerPool.

getEnvironmentVariablesCount

int getEnvironmentVariablesCount()

 User-provided build-time environment variables for the function
 

map<string, string> environment_variables = 6;

containsEnvironmentVariables

boolean containsEnvironmentVariables(String key)

 User-provided build-time environment variables for the function
 

map<string, string> environment_variables = 6;

getEnvironmentVariables

@Deprecated
Map<String,String> getEnvironmentVariables()

Deprecated.

Use getEnvironmentVariablesMap() instead.

getEnvironmentVariablesMap

Map<String,String> getEnvironmentVariablesMap()

 User-provided build-time environment variables for the function
 

map<string, string> environment_variables = 6;

getEnvironmentVariablesOrDefault

String getEnvironmentVariablesOrDefault(String key,
                                        String defaultValue)

 User-provided build-time environment variables for the function
 

map<string, string> environment_variables = 6;

getEnvironmentVariablesOrThrow

String getEnvironmentVariablesOrThrow(String key)

 User-provided build-time environment variables for the function
 

map<string, string> environment_variables = 6;

getDockerRegistryValue

int getDockerRegistryValue()

 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 `docker_repository` field is specified, this field will be automatically
 set as `ARTIFACT_REGISTRY`.
 If unspecified, it currently defaults to `CONTAINER_REGISTRY`.
 This field may be overridden by the backend for eligible deployments.
 

.google.cloud.functions.v2.BuildConfig.DockerRegistry docker_registry = 10;

Returns:

The enum numeric value on the wire for dockerRegistry.

getDockerRegistry

BuildConfig.DockerRegistry getDockerRegistry()

 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 `docker_repository` field is specified, this field will be automatically
 set as `ARTIFACT_REGISTRY`.
 If unspecified, it currently defaults to `CONTAINER_REGISTRY`.
 This field may be overridden by the backend for eligible deployments.
 

.google.cloud.functions.v2.BuildConfig.DockerRegistry docker_registry = 10;

Returns:

The dockerRegistry.

getDockerRepository

String getDockerRepository()

 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.resource_reference) = { ... }

Returns:

The dockerRepository.

getDockerRepositoryBytes

com.google.protobuf.ByteString getDockerRepositoryBytes()

 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.resource_reference) = { ... }

Returns:

The bytes for dockerRepository.