Summary of entries of Classes for cloudfunctions.
Classes
CloudFunctionsServiceAsyncClient
A service that application uses to manipulate triggers and functions.
CloudFunctionsServiceClient
A service that application uses to manipulate triggers and functions.
ListFunctionsAsyncPager
A pager for iterating through list_functions
requests.
This class thinly wraps an initial
ListFunctionsResponse object, and
provides an __aiter__
method to iterate through its
functions
field.
If there are more pages, the __aiter__
method will make additional
ListFunctions
requests and continue to iterate
through the functions
field on the
corresponding responses.
All the usual ListFunctionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListFunctionsPager
A pager for iterating through list_functions
requests.
This class thinly wraps an initial
ListFunctionsResponse object, and
provides an __iter__
method to iterate through its
functions
field.
If there are more pages, the __iter__
method will make additional
ListFunctions
requests and continue to iterate
through the functions
field on the
corresponding responses.
All the usual ListFunctionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
CallFunctionRequest
Request for the CallFunction
method.
CallFunctionResponse
Response of CallFunction
method.
CloudFunction
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
AutomaticUpdatePolicy
Security patches are applied automatically to the runtime without 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 is redeployed.
VpcConnectorEgressSettings
Available egress settings.
This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.
CloudFunctionStatus
Describes the current stage of a deployment.
CreateFunctionRequest
Request for the CreateFunction
method.
DeleteFunctionRequest
Request for the DeleteFunction
method.
EventTrigger
Describes EventTrigger, used to request events be sent from another service.
FailurePolicy
Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).
.. _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 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.
GenerateDownloadUrlRequest
Request of GenerateDownloadUrl
method.
GenerateDownloadUrlResponse
Response of GenerateDownloadUrl
method.
GenerateUploadUrlRequest
Request of GenerateSourceUploadUrl
method.
GenerateUploadUrlResponse
Response of GenerateSourceUploadUrl
method.
GetFunctionRequest
Request for the GetFunction
method.
HttpsTrigger
Describes HttpsTrigger, could be used to connect web hooks to function.
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 the ListFunctions
method.
ListFunctionsResponse
Response for the ListFunctions
method.
OperationMetadataV1
Metadata describing an Operation][google.longrunning.Operation]
OperationType
A type of an operation.
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.
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. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.
SecretVersion
Configuration for a single version.
SourceRepository
Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.
UpdateFunctionRequest
Request for the UpdateFunction
method.
FunctionServiceAsyncClient
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.
FunctionServiceClient
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.
ListFunctionsAsyncPager
A pager for iterating through list_functions
requests.
This class thinly wraps an initial
ListFunctionsResponse object, and
provides an __aiter__
method to iterate through its
functions
field.
If there are more pages, the __aiter__
method will make additional
ListFunctions
requests and continue to iterate
through the functions
field on the
corresponding responses.
All the usual ListFunctionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListFunctionsPager
A pager for iterating through list_functions
requests.
This class thinly wraps an initial
ListFunctionsResponse object, and
provides an __iter__
method to iterate through its
functions
field.
If there are more pages, the __iter__
method will make additional
ListFunctions
requests and continue to iterate
through the functions
field on the
corresponding responses.
All the usual ListFunctionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
AutomaticUpdatePolicy
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.
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.
.. _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 the CreateFunction
method.
DeleteFunctionRequest
Request for the DeleteFunction
method.
Environment
The environment the function is hosted on.
EventFilter
Filters events based on exact matches on the CloudEvents attributes.
EventTrigger
Describes EventTrigger, used to request events to be sent from another service.
RetryPolicy
Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution.
Function
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
LabelsEntry
The abstract base class for a message.
State
Describes the current state of the function.
GenerateDownloadUrlRequest
Request of GenerateDownloadUrl
method.
GenerateDownloadUrlResponse
Response of GenerateDownloadUrl
method.
GenerateUploadUrlRequest
Request of GenerateSourceUploadUrl
method.
GenerateUploadUrlResponse
Response of GenerateSourceUploadUrl
method.
GetFunctionRequest
Request for the GetFunction
method.
ListFunctionsRequest
Request for the ListFunctions
method.
ListFunctionsResponse
Response for the ListFunctions
method.
ListRuntimesRequest
Request for the ListRuntimes
method.
ListRuntimesResponse
Response for the ListRuntimes
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 is redeployed.
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 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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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.
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.
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, If unspecified, SECURE_OPTIONAL will be used. 2nd Gen functions are SECURE_ALWAYS ONLY.
VpcConnectorEgressSettings
Available egress settings.
This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.
Source
The location of the function source code.
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.
.. _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 Function or Operation.
Severity
Severity of the state message.
StorageSource
Location of the source in an archive file in Google Cloud Storage.
UpdateFunctionRequest
Request for the UpdateFunction
method.
Modules
pagers
API documentation for functions_v1.services.cloud_functions_service.pagers
module.
pagers
API documentation for functions_v2.services.function_service.pagers
module.