Package types (1.14.0)

API documentation for functions_v1.types package.

Classes

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 encapsulates 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

CloudFunctionStatus

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.

CreateFunctionRequest

Request for the CreateFunction method.

DeleteFunctionRequest

Request for the DeleteFunction method.

EventTrigger

Describes EventTrigger, used to request that 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

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.

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.

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.

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 file system read operation performs a lookup in Secret Manager to retrieve the secret value.

SourceRepository

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

UpdateFunctionRequest

Request for the UpdateFunction method.