As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Functions v1 API

class google.cloud.functions_v1.types.CallFunctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the CallFunction method.

name

Required. The name of the function to be called.

Type

str

data

Required. Input to be passed to the function.

Type

str

class google.cloud.functions_v1.types.CallFunctionResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of CallFunction method.

execution_id

Execution id of function invocation.

Type

str

result

Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context.

Type

str

error

Either system or user-function generated error. Set if execution was not successful.

Type

str

class google.cloud.functions_v1.types.CloudFunction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name

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

Type

str

description

User-provided description of a function.

Type

str

source_archive_url

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

This field is a member of oneof source_code.

Type

str

source_repository

Beta Feature

The source repository where a function is hosted.

This field is a member of oneof source_code.

Type

google.cloud.functions_v1.types.SourceRepository

source_upload_url

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].

The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

This field is a member of oneof source_code.

Type

str

https_trigger

An HTTPS endpoint type of source that can be triggered via URL.

This field is a member of oneof trigger.

Type

google.cloud.functions_v1.types.HttpsTrigger

event_trigger

A source that fires events in response to a condition in another service.

This field is a member of oneof trigger.

Type

google.cloud.functions_v1.types.EventTrigger

status

Output only. Status of the function deployment.

Type

google.cloud.functions_v1.types.CloudFunctionStatus

entry_point

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.

Type

str

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 `gcloud command reference <https://cloud.google.com/sdk/gcloud/reference/functions/deploy#–runtime>`__.

Type

str

timeout

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.

Type

google.protobuf.duration_pb2.Duration

available_memory_mb

The amount of memory in MB available for a function. Defaults to 256MB.

Type

int

service_account_email

The email of the function’s service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

Type

str

update_time

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

Type

google.protobuf.timestamp_pb2.Timestamp

version_id

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

Type

int

labels

Labels associated with this Cloud Function.

Type

MutableMapping[str, str]

environment_variables

Environment variables that shall be available during function execution.

Type

MutableMapping[str, str]

build_environment_variables

Build environment variables that shall be available during build time.

Type

MutableMapping[str, str]

network

Deprecated: use vpc_connector

Type

str

max_instances

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.

Type

int

min_instances

A lower bound for the number function instances that may coexist at a given time.

Type

int

vpc_connector

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/*

This field is mutually exclusive with network field and will eventually replace it.

See the VPC documentation for more information on connecting Cloud projects.

Type

str

vpc_connector_egress_settings

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

Type

google.cloud.functions_v1.types.CloudFunction.VpcConnectorEgressSettings

ingress_settings

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

Type

google.cloud.functions_v1.types.CloudFunction.IngressSettings

kms_key_name

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key.

The following service accounts need to be granted the role ‘Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)’ on the Key/KeyRing/Project/Organization (least access preferred).

1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function’s image.

2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function’s source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil.

Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

Type

str

build_worker_pool

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.

Type

str

build_id

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

Type

str

build_name

Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.

Type

str

secret_environment_variables

Secret environment variables configuration.

Type

MutableSequence[google.cloud.functions_v1.types.SecretEnvVar]

secret_volumes

Secret volumes configuration.

Type

MutableSequence[google.cloud.functions_v1.types.SecretVolume]

source_token

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

Type

str

docker_repository

User-managed repository created in Artifact Registry to which the function’s Docker image will be pushed after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK). If unspecified and docker_registry is not explicitly set to CONTAINER_REGISTRY, GCF will create and use a default Artifact Registry repository named ‘gcf-artifacts’ in the 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’.

Type

str

docker_registry

Docker Registry to use for this deployment.

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.

Type

google.cloud.functions_v1.types.CloudFunction.DockerRegistry

automatic_update_policy

This field is a member of oneof runtime_update_policy.

Type

google.cloud.functions_v1.types.CloudFunction.AutomaticUpdatePolicy

on_deploy_update_policy

This field is a member of oneof runtime_update_policy.

Type

google.cloud.functions_v1.types.CloudFunction.OnDeployUpdatePolicy

build_service_account

A service account the user provides for use with Cloud Build. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

Type

str

class AutomaticUpdatePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Security patches are applied automatically to the runtime without requiring the function to be redeployed.

class BuildEnvironmentVariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class DockerRegistry(value)

Bases: proto.enums.Enum

Docker Registry to use for storing function Docker images.

Values:

DOCKER_REGISTRY_UNSPECIFIED (0):

Unspecified.

CONTAINER_REGISTRY (1):

Docker images will be stored in multi-regional Container Registry repositories named gcf.

ARTIFACT_REGISTRY (2):

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.

class EnvironmentVariablesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class IngressSettings(value)

Bases: proto.enums.Enum

Available ingress settings.

This controls what traffic can reach the function.

If unspecified, ALLOW_ALL will be used.

Values:

INGRESS_SETTINGS_UNSPECIFIED (0):

Unspecified.

ALLOW_ALL (1):

Allow HTTP traffic from public and private sources.

ALLOW_INTERNAL_ONLY (2):

Allow HTTP traffic from only private VPC sources.

ALLOW_INTERNAL_AND_GCLB (3):

Allow HTTP traffic from private VPC sources and through GCLB.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class OnDeployUpdatePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Security patches are only applied when a function is redeployed.

runtime_version

Output only. Contains the runtime version which was used during latest function deployment.

Type

str

class VpcConnectorEgressSettings(value)

Bases: proto.enums.Enum

Available egress settings.

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

Values:

VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED (0):

Unspecified.

PRIVATE_RANGES_ONLY (1):

Use the VPC Access Connector only for private IP space from RFC1918.

ALL_TRAFFIC (2):

Force the use of VPC Access Connector for all egress traffic from the function.

class google.cloud.functions_v1.types.CloudFunctionStatus(value)

Bases: proto.enums.Enum

Describes the current stage of a deployment.

Values:

CLOUD_FUNCTION_STATUS_UNSPECIFIED (0):

Not specified. Invalid state.

ACTIVE (1):

Function has been successfully deployed and is serving.

OFFLINE (2):

Function deployment failed and the function isn’t serving.

DEPLOY_IN_PROGRESS (3):

Function is being created or updated.

DELETE_IN_PROGRESS (4):

Function is being deleted.

UNKNOWN (5):

Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.

class google.cloud.functions_v1.types.CreateFunctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the CreateFunction method.

location

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

Type

str

function

Required. Function to be created.

Type

google.cloud.functions_v1.types.CloudFunction

class google.cloud.functions_v1.types.DeleteFunctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the DeleteFunction method.

name

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

Type

str

class google.cloud.functions_v1.types.EventTrigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

event_type

Required. The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish.

Event types match pattern providers/*/eventTypes/*.*. The pattern contains:

1. namespace: For example, cloud.storage and google.firebase.analytics.

2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.

3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is ‘change’. These parts are lower case.

Type

str

resource

Required. The resource(s) from which to observe events, for example, projects/_/buckets/myBucket.

Not all syntactically correct values are accepted by all services. For example:

1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction.

2. The resource type must match the pattern expected for an event_type. For example, an EventTrigger that has an event_type of “google.pubsub.topic.publish” should have a resource that matches Google Cloud Pub/Sub topics.

Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized “long” format.

See each service’s documentation for supported formats.

Type

str

service

The hostname of the service that should be observed.

If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

Type

str

failure_policy

Specifies policy for failed executions.

Type

google.cloud.functions_v1.types.FailurePolicy

class google.cloud.functions_v1.types.FailurePolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes the policy in case of function’s execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).

retry

If specified, then the function will be retried in case of a failure.

This field is a member of oneof action.

Type

google.cloud.functions_v1.types.FailurePolicy.Retry

class Retry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes the retry policy in case of function’s execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution.

class google.cloud.functions_v1.types.GenerateDownloadUrlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request of GenerateDownloadUrl method.

name

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

Type

str

version_id

The optional version of function. If not set, default, current version is used.

Type

int

class google.cloud.functions_v1.types.GenerateDownloadUrlResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of GenerateDownloadUrl method.

download_url

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

Type

str

class google.cloud.functions_v1.types.GenerateUploadUrlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request of GenerateSourceUploadUrl method.

parent

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

Type

str

kms_key_name

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 projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

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). GCF will delegate access to the Google Storage service account in the internal project.

Type

str

class google.cloud.functions_v1.types.GenerateUploadUrlResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response of GenerateSourceUploadUrl method.

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.

Type

str

class google.cloud.functions_v1.types.GetFunctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the GetFunction method.

name

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

Type

str

version_id

Optional. The optional version of the 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. Each deployment creates a config version of the underlying function. GCF may keep historical configs for old versions. This field can be specified to fetch the historical configs. Leave it blank or set to 0 to get the latest version of the function.

Type

int

class google.cloud.functions_v1.types.HttpsTrigger(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes HttpsTrigger, could be used to connect web hooks to function.

url

Output only. The deployed url for the function.

Type

str

security_level

The security level for the function.

Type

google.cloud.functions_v1.types.HttpsTrigger.SecurityLevel

class SecurityLevel(value)

Bases: proto.enums.Enum

Available security level settings.

This controls the methods to enforce security (HTTPS) on a URL.

If unspecified, SECURE_OPTIONAL will be used.

Values:

SECURITY_LEVEL_UNSPECIFIED (0):

Unspecified.

SECURE_ALWAYS (1):

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 (2):

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.

class google.cloud.functions_v1.types.ListFunctionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the ListFunctions method.

parent

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.

Type

str

page_size

Maximum number of functions to return per call.

Type

int

page_token

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.

Type

str

class google.cloud.functions_v1.types.ListFunctionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response for the ListFunctions method.

functions

The functions that match the request.

Type

MutableSequence[google.cloud.functions_v1.types.CloudFunction]

next_page_token

If not empty, indicates that there may be more functions that match the request; this value should be passed in a new [google.cloud.functions.v1.ListFunctionsRequest][google.cloud.functions.v1.ListFunctionsRequest] to get more functions.

Type

str

unreachable

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

Type

MutableSequence[str]

class google.cloud.functions_v1.types.OperationMetadataV1(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata describing an [Operation][google.longrunning.Operation]

target

Target of the operation - for example projects/project-1/locations/region-1/functions/function-1

Type

str

type_

Type of operation.

Type

google.cloud.functions_v1.types.OperationType

request

The original request that started the operation.

Type

google.protobuf.any_pb2.Any

version_id

Version id of the function created or updated by an API call. This field is only populated for Create and Update operations.

Type

int

update_time

The last update timestamp of the operation.

Type

google.protobuf.timestamp_pb2.Timestamp

build_id

The Cloud Build ID of the function created or updated by an API call. This field is only populated for Create and Update operations.

Type

str

source_token

An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

Type

str

build_name

The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations. projects/<project-number>/locations/<region>/builds/<build-id>.

Type

str

class google.cloud.functions_v1.types.OperationType(value)

Bases: proto.enums.Enum

A type of an operation.

Values:

OPERATION_UNSPECIFIED (0):

Unknown operation type.

CREATE_FUNCTION (1):

Triggered by CreateFunction call

UPDATE_FUNCTION (2):

Triggered by UpdateFunction call

DELETE_FUNCTION (3):

Triggered by DeleteFunction call.

class google.cloud.functions_v1.types.SecretEnvVar(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

key

Name of the environment variable.

Type

str

project_id

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function’s project assuming that the secret exists in the same project as of the function.

Type

str

secret

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

Type

str

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.

Type

str

class google.cloud.functions_v1.types.SecretVolume(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.

mount_path

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 paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

Type

str

project_id

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function’s project assuming that the secret exists in the same project as of the function.

Type

str

secret

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

Type

str

versions

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.

Type

MutableSequence[google.cloud.functions_v1.types.SecretVolume.SecretVersion]

class SecretVersion(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a single version.

version

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.

Type

str

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 /secret_foo would mount the secret value file at /etc/secrets/secret_foo.

Type

str

class google.cloud.functions_v1.types.SourceRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.

url

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats:

To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*

You may omit paths/* if you want to use the main directory. The function response may add an empty /paths/ to the URL.

Type

str

deployed_url

Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

Type

str

class google.cloud.functions_v1.types.UpdateFunctionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request for the UpdateFunction method.

function

Required. New version of the function.

Type

google.cloud.functions_v1.types.CloudFunction

update_mask

Required. The list of fields in CloudFunction that have to be updated.

Type

google.protobuf.field_mask_pb2.FieldMask