Package types (1.0.4)

API documentation for functions_v1.types package.

Classes

CallFunctionRequest

Request for the CallFunction method. .. attribute:: name

Required. The name of the function to be called.

:type: str

CallFunctionResponse

Response of CallFunction method. .. attribute:: execution_id

Execution id of function invocation.

:type: str

CloudFunction

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

CloudFunctionStatus

Describes the current stage of a deployment.

CreateFunctionRequest

Request for the CreateFunction method. .. attribute:: location

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

:type: str

DeleteFunctionRequest

Request for the DeleteFunction method. .. attribute:: name

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

:type: str

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).

GenerateDownloadUrlRequest

Request of GenerateDownloadUrl method. .. attribute:: name

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

:type: str

GenerateDownloadUrlResponse

Response of GenerateDownloadUrl method. .. attribute:: download_url

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

:type: str

GenerateUploadUrlRequest

Request of GenerateSourceUploadUrl method. .. attribute:: parent

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

:type: str

GenerateUploadUrlResponse

Response of GenerateSourceUploadUrl method. .. attribute:: 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

GetFunctionRequest

Request for the GetFunction method. .. attribute:: name

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

:type: str

HttpsTrigger

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

ListFunctionsRequest

Request for the ListFunctions method. .. attribute:: 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

ListFunctionsResponse

Response for the ListFunctions method. .. attribute:: functions

The functions that match the request.

:type: Sequence[google.cloud.functions_v1.types.CloudFunction]

OperationMetadataV1

Metadata describing an Operation][google.longrunning.Operation] .. attribute:: target

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

:type: str

OperationType

A type of an operation.

SourceRepository

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

UpdateFunctionRequest

Request for the UpdateFunction method. .. attribute:: function

Required. New version of the function.

:type: google.cloud.functions_v1.types.CloudFunction