Package com.google.cloud.functions.v2

Interface BuildConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BuildConfig, BuildConfig.Builder
@Generated public interface BuildConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasAutomaticUpdatePolicy

      boolean hasAutomaticUpdatePolicy()
      .google.cloud.functions.v2.AutomaticUpdatePolicy automatic_update_policy = 40;
      Returns:
      Whether the automaticUpdatePolicy field is set.

    • getAutomaticUpdatePolicy

      AutomaticUpdatePolicy getAutomaticUpdatePolicy()
      .google.cloud.functions.v2.AutomaticUpdatePolicy automatic_update_policy = 40;
      Returns:
      The automaticUpdatePolicy.

    • getAutomaticUpdatePolicyOrBuilder

      AutomaticUpdatePolicyOrBuilder getAutomaticUpdatePolicyOrBuilder()
      .google.cloud.functions.v2.AutomaticUpdatePolicy automatic_update_policy = 40;

    • hasOnDeployUpdatePolicy

      boolean hasOnDeployUpdatePolicy()
      .google.cloud.functions.v2.OnDeployUpdatePolicy on_deploy_update_policy = 41;
      Returns:
      Whether the onDeployUpdatePolicy field is set.

    • getOnDeployUpdatePolicy

      OnDeployUpdatePolicy getOnDeployUpdatePolicy()
      .google.cloud.functions.v2.OnDeployUpdatePolicy on_deploy_update_policy = 41;
      Returns:
      The onDeployUpdatePolicy.

    • getOnDeployUpdatePolicyOrBuilder

      OnDeployUpdatePolicyOrBuilder getOnDeployUpdatePolicyOrBuilder()
      .google.cloud.functions.v2.OnDeployUpdatePolicy on_deploy_update_policy = 41;

    • 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

      @Deprecated int getDockerRegistryValue()
      Deprecated.
      google.cloud.functions.v2.BuildConfig.docker_registry is deprecated. See google/cloud/functions/v2/functions.proto;l=525
       Docker Registry to use for this deployment. This configuration is only
 applicable to 1st Gen functions, 2nd Gen functions can only use Artifact
 Registry.
 Deprecated: As of March 2025, `CONTAINER_REGISTRY` option is no longer
 available in response to Container Registry's deprecation:
 https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr
 Please use Artifact Registry instead, which is the default choice.

 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 [deprecated = true];
      Returns:
      The enum numeric value on the wire for dockerRegistry.

    • getDockerRegistry

      @Deprecated BuildConfig.DockerRegistry getDockerRegistry()
      Deprecated.
      google.cloud.functions.v2.BuildConfig.docker_registry is deprecated. See google/cloud/functions/v2/functions.proto;l=525
       Docker Registry to use for this deployment. This configuration is only
 applicable to 1st Gen functions, 2nd Gen functions can only use Artifact
 Registry.
 Deprecated: As of March 2025, `CONTAINER_REGISTRY` option is no longer
 available in response to Container Registry's deprecation:
 https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr
 Please use Artifact Registry instead, which is the default choice.

 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 [deprecated = true];
      Returns:
      The dockerRegistry.

    • getDockerRepository

      String getDockerRepository()
       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}`.
 Repository format must be 'DOCKER'.
      string docker_repository = 7 [(.google.api.resource_reference) = { ... }
      Returns:
      The dockerRepository.

    • getDockerRepositoryBytes

      com.google.protobuf.ByteString getDockerRepositoryBytes()
       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}`.
 Repository format must be 'DOCKER'.
      string docker_repository = 7 [(.google.api.resource_reference) = { ... }
      Returns:
      The bytes for dockerRepository.

    • getServiceAccount

      String getServiceAccount()
       Service account to be used for building the container. The format of this
 field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.
      string service_account = 27;
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      com.google.protobuf.ByteString getServiceAccountBytes()
       Service account to be used for building the container. The format of this
 field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.
      string service_account = 27;
      Returns:
      The bytes for serviceAccount.

    • getRuntimeUpdatePolicyCase

      BuildConfig.RuntimeUpdatePolicyCase getRuntimeUpdatePolicyCase()