2022-07-14
▼ ▲ cloudfunctions.projects.locations.functions.delete
Path: v2/{+name}
Description: Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.
HTTP Method: DELETE
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. The name of the function which should be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Parameter Order: name
▼ ▲ cloudfunctions.projects.locations.functions.get
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}
Path: v2/{+name}
Description: Returns a function with the given name from the requested project.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Description: Required. The name of the function which details should be obtained.
Type: string
Required: Yes
Location: path
HTTP Method: GET
Parameter Order: name
▼ ▲ cloudfunctions.projects.locations.functions.generateUploadUrl
Parameters:
parent
Description: Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
HTTP Method: POST
Description: Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN`
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl
Path: v2/{+parent}/functions:generateUploadUrl
▼ ▲ cloudfunctions.projects.locations.functions.generateDownloadUrl
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2/{+name}:generateDownloadUrl
Description: Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls
Parameter Order: name
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl
Parameters:
name
Type: string
Description: Required. The name of function for which source code Google Cloud Storage signed URL should be generated.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Location: path
HTTP Method: POST
▼ ▲ cloudfunctions.projects.locations.functions.list
Path: v2/{+parent}/functions
Description: Returns a list of functions that belong to the requested project.
Parameter Order: parent
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/functions
Parameters:
orderBy
Location: query
Description: The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.
Type: string
pageToken
Location: query
Description: 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: string
filter
Type: string
Location: query
Description: The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Required. 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.
pageSize
Description: Maximum number of functions to return per call.
Type: integer
Format: int32
Location: query
▼ ▲ cloudfunctions.projects.locations.functions.patch
Path: v2/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Type: string
Location: path
Required: Yes
updateMask
Type: string
Location: query
Description: The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.
Format: google-fieldmask
Parameter Order: name
HTTP Method: PATCH
Description: Updates existing function.
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}
▼ ▲ cloudfunctions.projects.locations.functions.create
HTTP Method: POST
Parameters:
functionId
Location: query
Description: The ID to use for the function, which will become the final component of the function's resource name. This value should be 4-63 characters, and valid characters are /a-z-/.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Location: path
Description: Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`
Required: Yes
Path: v2/{+parent}/functions
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/functions
Description: Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.
▼ ▲ cloudfunctions.projects.locations.runtimes.list
Path: v2/{+parent}/runtimes
Flat Path: v2/projects/{projectsId}/locations/{locationsId}/runtimes
Parameters:
parent
Location: path
Required: Yes
Description: Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*`
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
filter
Description: The filter for Runtimes that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
Location: query
Type: string
HTTP Method: GET
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns a list of runtimes that are supported for the requested project.