Package Classes (1.21.0)

Summary of entries of Classes for cloudfunctions.

Classes

CloudFunctionsServiceAsyncClient

A service that application uses to manipulate triggers andfunctions.

CloudFunctionsServiceClient

A service that application uses to manipulate triggers andfunctions.

ListFunctionsAsyncPager

A pager for iterating throughlist_functions requests.

This class thinly wraps an initialListFunctionsResponse object, andprovides an__aiter__ method to iterate through itsfunctions field.

If there are more pages, the__aiter__ method will make additionalListFunctions requests and continue to iteratethrough thefunctions field on thecorresponding responses.

All the usualListFunctionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListFunctionsPager

A pager for iterating throughlist_functions requests.

This class thinly wraps an initialListFunctionsResponse object, andprovides an__iter__ method to iterate through itsfunctions field.

If there are more pages, the__iter__ method will make additionalListFunctions requests and continue to iteratethrough thefunctions field on thecorresponding responses.

All the usualListFunctionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

CallFunctionRequest

Request for theCallFunction method.

CallFunctionResponse

Response ofCallFunction method.

CloudFunction

Describes a Cloud Function that contains user computationexecuted in response to an event. It encapsulate function andtriggers configurations.

This message hasoneof_ 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 othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AutomaticUpdatePolicy

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

BuildEnvironmentVariablesEntry

The abstract base class for a message.

DockerRegistry

Docker Registry to use for storing function Docker images.

EnvironmentVariablesEntry

The abstract base class for a message.

IngressSettings

Available ingress settings.

This controls what traffic can reach the function.

If unspecified, ALLOW_ALL will be used.

LabelsEntry

The abstract base class for a message.

OnDeployUpdatePolicy

Security patches are only applied when a function isredeployed.

VpcConnectorEgressSettings

Available egress settings.

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

CloudFunctionStatus

Describes the current stage of a deployment.

CreateFunctionRequest

Request for theCreateFunction method.

DeleteFunctionRequest

Request for theDeleteFunction method.

EventTrigger

Describes EventTrigger, used to request events be sent fromanother service.

FailurePolicy

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

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Retry

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

GenerateDownloadUrlRequest

Request ofGenerateDownloadUrl method.

GenerateDownloadUrlResponse

Response ofGenerateDownloadUrl method.

GenerateUploadUrlRequest

Request ofGenerateSourceUploadUrl method.

GenerateUploadUrlResponse

Response ofGenerateSourceUploadUrl method.

GetFunctionRequest

Request for theGetFunction method.

HttpsTrigger

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

SecurityLevel

Available security level settings.

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

If unspecified, SECURE_OPTIONAL will be used.

ListFunctionsRequest

Request for theListFunctions method.

ListFunctionsResponse

Response for theListFunctions method.

OperationMetadataV1

Metadata describing anOperation][google.longrunning.Operation]

OperationType

A type of an operation.

SecretEnvVar

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

SecretVolume

Configuration for a secret volume. It has the informationnecessary to fetch the secret value from secret manager and makeit available as files mounted at the requested paths within theapplication container. Secret value is not a part of theconfiguration. Every filesystem read operation performs a lookupin secret manager to retrieve the secret value.

SecretVersion

Configuration for a single version.

SourceRepository

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

UpdateFunctionRequest

Request for theUpdateFunction method.

FunctionServiceAsyncClient

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

Afunction is a resource which describes a function that shouldbe executed and how it is triggered.

FunctionServiceClient

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

Afunction is a resource which describes a function that shouldbe executed and how it is triggered.

ListFunctionsAsyncPager

A pager for iterating throughlist_functions requests.

This class thinly wraps an initialListFunctionsResponse object, andprovides an__aiter__ method to iterate through itsfunctions field.

If there are more pages, the__aiter__ method will make additionalListFunctions requests and continue to iteratethrough thefunctions field on thecorresponding responses.

All the usualListFunctionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

ListFunctionsPager

A pager for iterating throughlist_functions requests.

This class thinly wraps an initialListFunctionsResponse object, andprovides an__iter__ method to iterate through itsfunctions field.

If there are more pages, the__iter__ method will make additionalListFunctions requests and continue to iteratethrough thefunctions field on thecorresponding responses.

All the usualListFunctionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.

AutomaticUpdatePolicy

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

BuildConfig

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

This message hasoneof_ 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 othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DockerRegistry

Docker Registry to use for storing function Docker images.

EnvironmentVariablesEntry

The abstract base class for a message.

CreateFunctionRequest

Request for theCreateFunction method.

DeleteFunctionRequest

Request for theDeleteFunction method.

Environment

The environment the function is hosted on.

EventFilter

Filters events based on exact matches on the CloudEventsattributes.

EventTrigger

Describes EventTrigger, used to request events to be sentfrom another service.

RetryPolicy

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

Function

Describes a Cloud Function that contains user computationexecuted in response to an event. It encapsulates function andtrigger configurations.

LabelsEntry

The abstract base class for a message.

State

Describes the current state of the function.

GenerateDownloadUrlRequest

Request ofGenerateDownloadUrl method.

GenerateDownloadUrlResponse

Response ofGenerateDownloadUrl method.

GenerateUploadUrlRequest

Request ofGenerateSourceUploadUrl method.

GenerateUploadUrlResponse

Response ofGenerateSourceUploadUrl method.

GetFunctionRequest

Request for theGetFunction method.

ListFunctionsRequest

Request for theListFunctions method.

ListFunctionsResponse

Response for theListFunctions method.

ListRuntimesRequest

Request for theListRuntimes method.

ListRuntimesResponse

Response for theListRuntimes method.

Runtime

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

RuntimeStage

The various stages that a runtime can be in.

LocationMetadata

Extra GCF specific location information.

OnDeployUpdatePolicy

Security patches are only applied when a function isredeployed.

OperationMetadata

Represents the metadata of the long-running operation.

OperationType

The type of the long running operation.

RepoSource

Location of the source in a Google Cloud Source Repository.

This message hasoneof_ 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 othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SecretEnvVar

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

SecretVolume

Configuration for a secret volume. It has the informationnecessary to fetch the secret value from secret manager and makeit available as files mounted at the requested paths within theapplication container.

SecretVersion

Configuration for a single version.

ServiceConfig

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

EnvironmentVariablesEntry

The abstract base class for a message.

IngressSettings

Available ingress settings.

This controls what traffic can reach the function.

If unspecified, ALLOW_ALL will be used.

SecurityLevel

Available security level settings.

This enforces security protocol on function URL.

Security level is only configurable for 1st Gen functions, Ifunspecified, SECURE_OPTIONAL will be used. 2nd Gen functions areSECURE_ALWAYS ONLY.

VpcConnectorEgressSettings

Available egress settings.

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

Source

The location of the function source code.

This message hasoneof_ 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 othermembers.

.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SourceProvenance

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

Stage

Each Stage of the deployment process

Name

Possible names for a Stage

State

Possible states for a Stage

StateMessage

Informational messages about the state of the Cloud Functionor Operation.

Severity

Severity of the state message.

StorageSource

Location of the source in an archive file in Google CloudStorage.

UpdateFunctionRequest

Request for theUpdateFunction method.

Modules

pagers

API documentation forfunctions_v1.services.cloud_functions_service.pagers module.

pagers

API documentation forfunctions_v2.services.function_service.pagers module.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-11-13 UTC.