Package google.cloud.functions.v2

Stay organized with collections Save and categorize content based on your preferences.

Index

FunctionService

Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data.

A function is a resource which describes a function that should be executed and how it is triggered.

CreateFunction

rpc CreateFunction(CreateFunctionRequest) returns (Operation)

Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return ALREADY_EXISTS error.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

DeleteFunction

rpc DeleteFunction(DeleteFunctionRequest) returns (Operation)

Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GenerateDownloadUrl

rpc GenerateDownloadUrl(GenerateDownloadUrlRequest) returns (GenerateDownloadUrlResponse)

Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GenerateUploadUrl

rpc GenerateUploadUrl(GenerateUploadUrlRequest) returns (GenerateUploadUrlResponse)

Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code.

When uploading source code to the generated signed URL, please follow these restrictions:

  • Source file type should be a zip file.
  • No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL.

When making a HTTP PUT request, these two headers need to be specified:

  • content-type: application/zip

And this header SHOULD NOT be specified:

  • Authorization: Bearer YOUR_TOKEN
Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

GetFunction

rpc GetFunction(GetFunctionRequest) returns (Function)

Returns a function with the given name from the requested project.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListFunctions

rpc ListFunctions(ListFunctionsRequest) returns (ListFunctionsResponse)

Returns a list of functions that belong to the requested project.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

ListRuntimes

rpc ListRuntimes(ListRuntimesRequest) returns (ListRuntimesResponse)

Returns a list of runtimes that are supported for the requested project.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

UpdateFunction

rpc UpdateFunction(UpdateFunctionRequest) returns (Operation)

Updates existing function.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

BuildConfig

Describes the Build step of the function that builds a container from the given source.

Fields
build

string

Output only. The Cloud Build name of the latest successful deployment of the function.

runtime

string

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.

entry_point

string

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.

source

Source

The location of the function source code.

source_provenance

SourceProvenance

Output only. A permanent fixed identifier for source.

worker_pool

string

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-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

environment_variables

map<string, string>

User-provided build-time environment variables for the function

docker_repository

string

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'.

CreateFunctionRequest

Request for the CreateFunction method.

Fields
parent

string

Required. The project and location in which the function should be created, specified in the format projects/*/locations/*

Authorization requires the following IAM permission on the specified resource parent:

  • cloudfunctions.functions.create
function

Function

Required. Function to be created.

function_id

string

The ID to use for the function, which will become the final component of the function's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

DeleteFunctionRequest

Request for the DeleteFunction method.

Fields
name

string

Required. The name of the function which should be deleted.

Authorization requires the following IAM permission on the specified resource name:

  • cloudfunctions.functions.delete

Environment

The environment the function is hosted on.

Enums
ENVIRONMENT_UNSPECIFIED Unspecified
GEN_1 Gen 1
GEN_2 Gen 2

EventFilter

Filters events based on exact matches on the CloudEvents attributes.

Fields
attribute

string

Required. The name of a CloudEvents attribute.

value

string

Required. The value for the attribute.

operator

string

Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is match-path-pattern.

EventTrigger

Describes EventTrigger, used to request events to be sent from another service.

Fields
trigger

string

Output only. The resource name of the Eventarc trigger. The format of this field is projects/{project}/locations/{region}/triggers/{trigger}.

trigger_region

string

The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.

event_type

string

Required. The type of event to observe. For example: google.cloud.audit.log.v1.written or google.cloud.pubsub.topic.v1.messagePublished.

event_filters[]

EventFilter

Criteria used to filter events.

pubsub_topic

string

Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: projects/{project}/topics/{topic}.

This is only valid for events of type google.cloud.pubsub.topic.v1.messagePublished. The topic provided here will not be deleted at function deletion.

service_account_email

string

Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is run.routes.invoke. If empty, defaults to the Compute Engine default service account: {project_number}-compute@developer.gserviceaccount.com.

retry_policy

RetryPolicy

Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).

channel

string

Optional. The name of the channel associated with the trigger in projects/{project}/locations/{location}/channels/{channel} format. You must provide a channel to receive events from Eventarc SaaS partners.

RetryPolicy

Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution.

Enums
RETRY_POLICY_UNSPECIFIED Not specified.
RETRY_POLICY_DO_NOT_RETRY Do not retry.
RETRY_POLICY_RETRY Retry on any failure, retry up to 7 days with an exponential backoff (capped at 10 seconds).

Function

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.

Fields
name

string

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

environment

Environment

Describe whether the function is gen1 or gen2.

description

string

User-provided description of a function.

build_config

BuildConfig

Describes the Build step of the function that builds a container from the given source.

service_config

ServiceConfig

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

event_trigger

EventTrigger

An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.

state

State

Output only. State of the function.

update_time

Timestamp

Output only. The last update timestamp of a Cloud Function.

labels

map<string, string>

Labels associated with this Cloud Function.

state_messages[]

StateMessage

Output only. State Messages for this Cloud Function.

State

Describes the current state of the function.

Enums
STATE_UNSPECIFIED Not specified. Invalid state.
ACTIVE Function has been successfully deployed and is serving.
FAILED Function deployment failed and the function is not serving.
DEPLOYING Function is being created or updated.
DELETING Function is being deleted.
UNKNOWN Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.

GenerateDownloadUrlRequest

Request of GenerateDownloadUrl method.

Fields
name

string

Required. The name of function for which source code Google Cloud Storage signed URL should be generated.

Authorization requires the following IAM permission on the specified resource name:

  • cloudfunctions.functions.sourceCodeGet

GenerateDownloadUrlResponse

Response of GenerateDownloadUrl method.

Fields
download_url

string

The generated Google Cloud Storage signed URL that should be used for function source code download.

GenerateUploadUrlRequest

Request of GenerateSourceUploadUrl method.

Fields
parent

string

Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format projects/*/locations/*.

Authorization requires the following IAM permission on the specified resource parent:

  • cloudfunctions.functions.sourceCodeSet

GenerateUploadUrlResponse

Response of GenerateSourceUploadUrl method.

Fields
upload_url

string

The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function.

storage_source

StorageSource

The location of the source code in the upload bucket.

Once the archive is uploaded using the upload_url use this field to set the function.build_config.source.storage_source during CreateFunction and UpdateFunction.

Generation defaults to 0, as Cloud Storage provides a new generation only upon uploading a new object or version of an object.

GetFunctionRequest

Request for the GetFunction method.

Fields
name

string

Required. The name of the function which details should be obtained.

Authorization requires the following IAM permission on the specified resource name:

  • cloudfunctions.functions.get

ListFunctionsRequest

Request for the ListFunctions method.

Fields
parent

string

Required. The project and location from which the function should be listed, specified in the format projects/*/locations/* If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.

Authorization requires the following IAM permission on the specified resource parent:

  • cloudfunctions.functions.list
page_size

int32

Maximum number of functions to return per call.

page_token

string

The value returned by the last ListFunctionsResponse; indicates that this is a continuation of a prior ListFunctions call, and that the system should return the next page of data.

filter

string

The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

order_by

string

The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.

ListFunctionsResponse

Response for the ListFunctions method.

Fields
functions[]

Function

The functions that match the request.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

unreachable[]

string

Locations that could not be reached. The response does not include any functions from these locations.

ListRuntimesRequest

Request for the ListRuntimes method.

Fields
parent

string

Required. The project and location from which the runtimes should be listed, specified in the format projects/*/locations/*

Authorization requires the following IAM permission on the specified resource parent:

  • cloudfunctions.runtimes.list
filter

string

The filter for Runtimes that match the filter expression, following the syntax outlined in https://google.aip.dev/160.

ListRuntimesResponse

Response for the ListRuntimes method.

Fields
runtimes[]

Runtime

The runtimes that match the request.

Runtime

Describes a runtime and any special information (e.g., deprecation status) related to it.

Fields
name

string

The name of the runtime, e.g., 'go113', 'nodejs12', etc.

display_name

string

The user facing name, eg 'Go 1.13', 'Node.js 12', etc.

stage

RuntimeStage

The stage of life this runtime is in, e.g., BETA, GA, etc.

warnings[]

string

Warning messages, e.g., a deprecation warning.

environment

Environment

The environment for the runtime.

RuntimeStage

The various stages that a runtime can be in.

Enums
RUNTIME_STAGE_UNSPECIFIED Not specified.
DEVELOPMENT The runtime is in development.
ALPHA The runtime is in the Alpha stage.
BETA The runtime is in the Beta stage.
GA The runtime is generally available.
DEPRECATED The runtime is deprecated.
DECOMMISSIONED The runtime is no longer supported.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
create_time

Timestamp

The time the operation was created.

end_time

Timestamp

The time the operation finished running.

target

string

Server-defined resource path for the target of the operation.

verb

string

Name of the verb executed by the operation.

status_detail

string

Human-readable status of the operation, if any.

cancel_requested

bool

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [Operation.error][] value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

api_version

string

API version used to start the operation.

request_resource

Any

The original request that started the operation.

stages[]

Stage

Mechanism for reporting in-progress stages

RepoSource

Location of the source in a Google Cloud Source Repository.

Fields
project_id

string

ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

repo_name

string

Name of the Cloud Source Repository.

dir

string

Directory, relative to the source root, in which to run the build.

This must be a relative path. If a step's dir is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)

invert_regex

bool

Only trigger a build if the revision regex does NOT match the revision regex.

Union field revision. A revision within the Cloud Source Repository must be specified in one of these ways. revision can be only one of the following:
branch_name

string

Regex matching branches to build.

The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax

tag_name

string

Regex matching tags to build.

The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax

commit_sha

string

Explicit commit SHA to build.

SecretEnvVar

Configuration for a secret environment variable. It has the information necessary to fetch the secret value from secret manager and expose it as an environment variable.

Fields
key

string

Name of the environment variable.

project_id

string

Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.

secret

string

Name of the secret in secret manager (not the full resource name).

version

string

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

SecretVolume

Configuration for a secret volume. It has the information necessary to fetch the secret value from secret manager and make it available as files mounted at the requested paths within the application container.

Fields
mount_path

string

The path within the container to mount the secret volume. For example, setting the mount_path as /etc/secrets would mount the secret value files under the /etc/secrets directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets

project_id

string

Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.

secret

string

Name of the secret in secret manager (not the full resource name).

versions[]

SecretVersion

List of secret versions to mount for this secret. If empty, the latest version of the secret will be made available in a file named after the secret under the mount point.

SecretVersion

Configuration for a single version.

Fields
version

string

Version of the secret (version number or the string 'latest'). It is preferable to use latest version with secret volumes as secret value changes are reflected immediately.

path

string

Relative path of the file under the mount path where the secret value for this version will be fetched and made available. For example, setting the mount_path as '/etc/secrets' and path as secret_foo would mount the secret value file at /etc/secrets/secret_foo.

ServiceConfig

Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).

Fields
service

string

Output only. Name of the service associated with a Function. The format of this field is projects/{project}/locations/{region}/services/{service}

timeout_seconds

int32

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

available_memory

string

The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.

environment_variables

map<string, string>

Environment variables that shall be available during function execution.

max_instance_count

int32

The limit on the maximum number of function instances that may coexist at a given time.

In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate.

See the Max Instances Guide for more details.

min_instance_count

int32

The limit on the minimum number of function instances that may coexist at a given time.

Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.

vpc_connector

string

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*.

vpc_connector_egress_settings

VpcConnectorEgressSettings

The egress settings for the connector, controlling what traffic is diverted through it.

ingress_settings

IngressSettings

The ingress settings for the function, controlling what traffic can reach it.

uri

string

Output only. URI of the Service deployed.

service_account_email

string

The email of the service's service account. If empty, defaults to {project_number}-compute@developer.gserviceaccount.com.

all_traffic_on_latest_revision

bool

Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.

secret_environment_variables[]

SecretEnvVar

Secret environment variables configuration.

secret_volumes[]

SecretVolume

Secret volumes configuration.

revision

string

Output only. The name of service revision.

IngressSettings

Available ingress settings.

This controls what traffic can reach the function.

If unspecified, ALLOW_ALL will be used.

Enums
INGRESS_SETTINGS_UNSPECIFIED Unspecified.
ALLOW_ALL Allow HTTP traffic from public and private sources.
ALLOW_INTERNAL_ONLY Allow HTTP traffic from only private VPC sources.
ALLOW_INTERNAL_AND_GCLB Allow HTTP traffic from private VPC sources and through GCLB.

VpcConnectorEgressSettings

Available egress settings.

This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.

Enums
VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED Unspecified.
PRIVATE_RANGES_ONLY Use the VPC Access Connector only for private IP space from RFC1918.
ALL_TRAFFIC Force the use of VPC Access Connector for all egress traffic from the function.

Source

The location of the function source code.

Fields
Union field source. Location of the source. At least one source needs to be provided for the deployment to succeed. source can be only one of the following:
storage_source

StorageSource

If provided, get the source from this location in Google Cloud Storage.

repo_source

RepoSource

If provided, get the source from this location in a Cloud Source Repository.

SourceProvenance

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.

Fields
resolved_storage_source

StorageSource

A copy of the build's source.storage_source, if exists, with any generations resolved.

resolved_repo_source

RepoSource

A copy of the build's source.repo_source, if exists, with any revisions resolved.

Stage

Each Stage of the deployment process

Fields
name

Name

Name of the Stage. This will be unique for each Stage.

message

string

Message describing the Stage

state

State

Current state of the Stage

resource

string

Resource of the Stage

resource_uri

string

Link to the current Stage resource

state_messages[]

StateMessage

State messages from the current Stage.

Name

Possible names for a Stage

Enums
NAME_UNSPECIFIED Not specified. Invalid name.
ARTIFACT_REGISTRY Artifact Regsitry Stage
BUILD Build Stage
SERVICE Service Stage
TRIGGER Trigger Stage
SERVICE_ROLLBACK Service Rollback Stage
TRIGGER_ROLLBACK Trigger Rollback Stage

State

Possible states for a Stage

Enums
STATE_UNSPECIFIED Not specified. Invalid state.
NOT_STARTED Stage has not started.
IN_PROGRESS Stage is in progress.
COMPLETE Stage has completed.

StateMessage

Informational messages about the state of the Cloud Function or Operation.

Fields
severity

Severity

Severity of the state message.

type

string

One-word CamelCase type of the state message.

message

string

The message.

Severity

Severity of the state message.

Enums
SEVERITY_UNSPECIFIED Not specified. Invalid severity.
ERROR ERROR-level severity.
WARNING WARNING-level severity.
INFO INFO-level severity.

StorageSource

Location of the source in an archive file in Google Cloud Storage.

Fields
bucket

string

Google Cloud Storage bucket containing the source (see Bucket Name Requirements).

object

string

Google Cloud Storage object containing the source.

This object must be a gzipped archive file (.tar.gz) containing source to build.

generation

int64

Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.

UpdateFunctionRequest

Request for the UpdateFunction method.

Fields
function

Function

Required. New version of the function.

Authorization requires the following IAM permission on the specified resource function:

  • cloudfunctions.functions.update
update_mask

FieldMask

The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.