Index
FunctionService
(interface)AutomaticUpdatePolicy
(message)BuildConfig
(message)BuildConfig.DockerRegistry
(enum)CreateFunctionRequest
(message)DeleteFunctionRequest
(message)Environment
(enum)EventFilter
(message)EventTrigger
(message)EventTrigger.RetryPolicy
(enum)Function
(message)Function.State
(enum)GenerateDownloadUrlRequest
(message)GenerateDownloadUrlResponse
(message)GenerateUploadUrlRequest
(message)GenerateUploadUrlResponse
(message)GetFunctionRequest
(message)ListFunctionsRequest
(message)ListFunctionsResponse
(message)ListRuntimesRequest
(message)ListRuntimesResponse
(message)ListRuntimesResponse.Runtime
(message)ListRuntimesResponse.RuntimeStage
(enum)LocationMetadata
(message)OnDeployUpdatePolicy
(message)OperationMetadata
(message)OperationType
(enum)RepoSource
(message)SecretEnvVar
(message)SecretVolume
(message)SecretVolume.SecretVersion
(message)ServiceConfig
(message)ServiceConfig.IngressSettings
(enum)ServiceConfig.SecurityLevel
(enum)ServiceConfig.VpcConnectorEgressSettings
(enum)Source
(message)SourceProvenance
(message)Stage
(message)Stage.Name
(enum)Stage.State
(enum)StateMessage
(message)StateMessage.Severity
(enum)StorageSource
(message)UpdateFunctionRequest
(message)
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 |
---|
Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return
|
DeleteFunction |
---|
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.
|
GenerateDownloadUrl |
---|
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
|
GenerateUploadUrl |
---|
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:
When making a HTTP PUT request, specify this header:
Do not specify this header:
|
GetFunction |
---|
Returns a function with the given name from the requested project.
|
ListFunctions |
---|
Returns a list of functions that belong to the requested project.
|
ListRuntimes |
---|
Returns a list of runtimes that are supported for the requested project.
|
UpdateFunction |
---|
Updates existing function.
|
AutomaticUpdatePolicy
This type has no fields.
Security patches are applied automatically to the runtime without requiring the function to be redeployed.
BuildConfig
Describes the Build step of the function that builds a container from the given source.
Fields | |
---|---|
build |
Output only. The Cloud Build name of the latest successful deployment of the function. |
runtime |
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 |
entry_point |
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 |
The location of the function source code. |
source_provenance |
Output only. A permanent fixed identifier for source. |
worker_pool |
Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is If the project id is not the same as the function, then the Cloud Functions Service Agent (service- |
environment_variables |
User-provided build-time environment variables for the function |
docker_registry |
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 |
docker_repository |
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 Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. |
service_account |
Service account to be used for building the container. The format of this field is |
source_token |
An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. |
Union field runtime_update_policy . This controls when security patches are applied to the runtime environment. runtime_update_policy can be only one of the following: |
|
automatic_update_policy |
|
on_deploy_update_policy |
DockerRegistry
Docker Registry to use for storing function Docker images.
Enums | |
---|---|
DOCKER_REGISTRY_UNSPECIFIED |
Unspecified. |
CONTAINER_REGISTRY |
Docker images will be stored in multi-regional Container Registry repositories named gcf . |
ARTIFACT_REGISTRY |
Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named gcf-artifacts in every region in which a function is deployed. But the repository to use can also be specified by the user using the docker_repository field. |
CreateFunctionRequest
Request for the CreateFunction
method.
Fields | |
---|---|
parent |
Required. The project and location in which the function should be created, specified in the format Authorization requires the following IAM permission on the specified resource
|
function |
Required. Function to be created. |
function_id |
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 |
Required. The name of the function which should be deleted. Authorization requires the following IAM permission on the specified resource
|
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 |
Required. The name of a CloudEvents attribute. |
value |
Required. The value for the attribute. |
operator |
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 |
EventTrigger
Describes EventTrigger, used to request events to be sent from another service.
Fields | |
---|---|
trigger |
Output only. The resource name of the Eventarc trigger. The format of this field is |
trigger_region |
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 |
Required. The type of event to observe. For example: |
event_filters[] |
Criteria used to filter events. |
pubsub_topic |
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: This is only valid for events of type |
service_account_email |
Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is |
retry_policy |
Optional. If unset, then defaults to ignoring failures (i.e. not retrying them). |
channel |
Optional. The name of the channel associated with the trigger in |
service |
Optional. The hostname of the service that 1st Gen function should be observed. If no string is provided, the default service implementing the API will be used. For example, The field is only applicable to 1st Gen functions. |
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 |
A user-defined name of the function. Function names must be unique globally and match pattern |
description |
User-provided description of a function. |
build_config |
Describes the Build step of the function that builds a container from the given source. |
service_config |
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed). |
event_trigger |
An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. |
state |
Output only. State of the function. |
update_time |
Output only. The last update timestamp of a Cloud Function. |
labels |
Labels associated with this Cloud Function. |
state_messages[] |
Output only. State Messages for this Cloud Function. |
environment |
Describe whether the function is 1st Gen or 2nd Gen. |
url |
Output only. The deployed url for the function. |
kms_key_name |
[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern |
satisfies_pzs |
Output only. Reserved for future use. |
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 |
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
|
GenerateDownloadUrlResponse
Response of GenerateDownloadUrl
method.
Fields | |
---|---|
download_url |
The generated Google Cloud Storage signed URL that should be used for function source code download. |
GenerateUploadUrlRequest
Request of GenerateSourceUploadUrl
method.
Fields | |
---|---|
parent |
Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format Authorization requires the following IAM permission on the specified resource
|
kms_key_name |
[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment. It must match the pattern The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). |
environment |
The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated. |
GenerateUploadUrlResponse
Response of GenerateSourceUploadUrl
method.
Fields | |
---|---|
upload_url |
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 |
The location of the source code in the upload bucket. Once the archive is uploaded using the 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 |
Required. The name of the function which details should be obtained. Authorization requires the following IAM permission on the specified resource
|
revision |
Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function. |
ListFunctionsRequest
Request for the ListFunctions
method.
Fields | |
---|---|
parent |
Required. The project and location from which the function should be listed, specified in the format Authorization requires the following IAM permission on the specified resource
|
page_size |
Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters. |
page_token |
The value returned by the last |
filter |
The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160. |
order_by |
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[] |
The functions that match the request. |
next_page_token |
A token, which can be sent as |
unreachable[] |
Locations that could not be reached. The response does not include any functions from these locations. |
ListRuntimesRequest
Request for the ListRuntimes
method.
Fields | |
---|---|
parent |
Required. The project and location from which the runtimes should be listed, specified in the format Authorization requires the following IAM permission on the specified resource
|
filter |
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[] |
The runtimes that match the request. |
Runtime
Describes a runtime and any special information (e.g., deprecation status) related to it.
Fields | |
---|---|
name |
The name of the runtime, e.g., 'go113', 'nodejs12', etc. |
display_name |
The user facing name, eg 'Go 1.13', 'Node.js 12', etc. |
stage |
The stage of life this runtime is in, e.g., BETA, GA, etc. |
warnings[] |
Warning messages, e.g., a deprecation warning. |
environment |
The environment for the runtime. |
deprecation_date |
Deprecation date for the runtime. |
decommission_date |
Decommission date 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. |
LocationMetadata
Extra GCF specific location information.
Fields | |
---|---|
environments[] |
The Cloud Function environments this location supports. |
OnDeployUpdatePolicy
Security patches are only applied when a function is redeployed.
Fields | |
---|---|
runtime_version |
Output only. contains the runtime version which was used during latest function deployment. |
OperationMetadata
Represents the metadata of the long-running operation.
Fields | |
---|---|
create_time |
The time the operation was created. |
end_time |
The time the operation finished running. |
target |
Server-defined resource path for the target of the operation. |
verb |
Name of the verb executed by the operation. |
status_detail |
Human-readable status of the operation, if any. |
cancel_requested |
Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have |
api_version |
API version used to start the operation. |
request_resource |
The original request that started the operation. |
stages[] |
Mechanism for reporting in-progress stages |
source_token |
An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. |
operation_type |
The operation type. |
OperationType
The type of the long running operation.
Enums | |
---|---|
OPERATIONTYPE_UNSPECIFIED |
Unspecified |
CREATE_FUNCTION |
CreateFunction |
UPDATE_FUNCTION |
UpdateFunction |
DELETE_FUNCTION |
DeleteFunction |
RepoSource
Location of the source in a Google Cloud Source Repository.
Fields | |
---|---|
project_id |
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. |
repo_name |
Name of the Cloud Source Repository. |
dir |
Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's |
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 |
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 |
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 |
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 |
Name of the environment variable. |
project_id |
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 |
Name of the secret in secret manager (not the full resource name). |
version |
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 |
The path within the container to mount the secret volume. For example, setting the mount_path as |
project_id |
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 |
Name of the secret in secret manager (not the full resource name). |
versions[] |
List of secret versions to mount for this secret. If empty, the |
SecretVersion
Configuration for a single version.
Fields | |
---|---|
version |
Version of the secret (version number or the string 'latest'). It is preferable to use |
path |
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 |
ServiceConfig
Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
Fields | |
---|---|
service |
Output only. Name of the service associated with a Function. The format of this field is |
timeout_seconds |
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 |
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. |
available_cpu |
The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU |
environment_variables |
Environment variables that shall be available during function execution. |
max_instance_count |
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 |
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 |
The Serverless VPC Access connector that this cloud function can connect to. The format of this field is |
vpc_connector_egress_settings |
The egress settings for the connector, controlling what traffic is diverted through it. |
ingress_settings |
The ingress settings for the function, controlling what traffic can reach it. |
uri |
Output only. URI of the Service deployed. |
service_account_email |
The email of the service's service account. If empty, defaults to |
all_traffic_on_latest_revision |
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[] |
Secret environment variables configuration. |
secret_volumes[] |
Secret volumes configuration. |
revision |
Output only. The name of service revision. |
max_instance_request_concurrency |
Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1. |
security_level |
Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY. |
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. |
SecurityLevel
Available security level settings.
This enforces security protocol on function URL.
Security level is only configurable for 1st Gen functions, If unspecified, SECURE_OPTIONAL will be used. 2nd Gen functions are SECURE_ALWAYS ONLY.
Enums | |
---|---|
SECURITY_LEVEL_UNSPECIFIED |
Unspecified. |
SECURE_ALWAYS |
Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect. |
SECURE_OPTIONAL |
Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly. |
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 |
If provided, get the source from this location in Google Cloud Storage. |
repo_source |
If provided, get the source from this location in a Cloud Source Repository. |
git_uri |
If provided, get the source from GitHub repository. This option is valid only for GCF 1st Gen function. Example: https://github.com/ |
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 |
A copy of the build's |
resolved_repo_source |
A copy of the build's |
git_uri |
A copy of the build's |
Stage
Each Stage of the deployment process
Fields | |
---|---|
name |
Name of the Stage. This will be unique for each Stage. |
message |
Message describing the Stage |
state |
Current state of the Stage |
resource |
Resource of the Stage |
resource_uri |
Link to the current Stage resource |
state_messages[] |
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 of the state message. |
type |
One-word CamelCase type of the state message. |
message |
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 |
Google Cloud Storage bucket containing the source (see Bucket Name Requirements). |
object |
Google Cloud Storage object containing the source. This object must be a gzipped archive file ( |
generation |
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 |
Required. New version of the function. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated. |