2022-02-15
▼ ▲ cloudfunctions.projects.locations.operations.list
Path: v2alpha/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Location: query
Type: integer
Format: int32
Description: The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set, the default page size is 100. Pagination is only supported when querying for a specific function.
filter
Location: query
Type: string
Description: Required. A filter for matching the requested operations. The supported formats of *filter* are: To query for a specific function: project:*,location:*,function:* To query for all of the latest operations for a project: project:*,latest:true
pageToken
Location: query
Type: string
Description: Token identifying which result to start with, which is returned by a previous list call. Pagination is only supported when querying for a specific function.
name
Type: string
Description: Must not be set.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
HTTP Method: GET
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/operations
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameter Order: name
▼ ▲ cloudfunctions.projects.locations.operations.get
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Type: string
Required: Yes
Description: The name of the operation resource.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v2alpha/{+name}
▼ ▲ cloudfunctions.projects.locations.runtimes.list
Parameters:
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
parent
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*`
Parameter Order: parent
HTTP Method: GET
Description: Returns a list of runtimes that are supported for the requested project.
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/runtimes
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2alpha/{+parent}/runtimes
▼ ▲ cloudfunctions.projects.locations.functions.getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Required: Yes
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
Format: int32
Location: query
HTTP Method: GET
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:getIamPolicy
Path: v2alpha/{+resource}:getIamPolicy
Parameter Order: resource
▼ ▲ cloudfunctions.projects.locations.functions.testIamPermissions
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path: v2alpha/{+resource}:testIamPermissions
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Location: path
Required: Yes
Type: string
▼ ▲ cloudfunctions.projects.locations.functions.delete
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. The name of the function which should be deleted.
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Path: v2alpha/{+name}
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}
HTTP Method: DELETE
Parameter Order: name
▼ ▲ cloudfunctions.projects.locations.functions.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy
Parameter Order: resource
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameters:
resource
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Location: path
Required: Yes
Path: v2alpha/{+resource}:setIamPolicy
▼ ▲ cloudfunctions.projects.locations.functions.list
Parameters:
filter
Location: query
Type: string
Description: The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
parent
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.
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
pageToken
Type: string
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.
pageSize
Type: integer
Format: int32
Location: query
Description: Maximum number of functions to return per call.
orderBy
Type: string
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.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v2alpha/{+parent}/functions
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions
Description: Returns a list of functions that belong to the requested project.
Parameter Order: parent
▼ ▲ cloudfunctions.projects.locations.functions.get
Path: v2alpha/{+name}
Description: Returns a function with the given name from the requested project.
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}
Parameters:
name
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Description: Required. The name of the function which details should be obtained.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: name
▼ ▲ cloudfunctions.projects.locations.functions.generateDownloadUrl
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl
Parameter Order: name
HTTP Method: POST
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
Path: v2alpha/{+name}:generateDownloadUrl
Parameters:
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Required: Yes
Description: Required. The name of function for which source code Google Cloud Storage signed URL should be generated.
Type: string
▼ ▲ cloudfunctions.projects.locations.functions.create
Path: v2alpha/{+parent}/functions
HTTP Method: POST
Parameters:
parent
Location: path
Type: string
Description: Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
functionId
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
Location: query
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions
Scopes: https://www.googleapis.com/auth/cloud-platform
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.
Parameter Order: parent
▼ ▲ cloudfunctions.projects.locations.functions.generateUploadUrl
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl
Path: v2alpha/{+parent}/functions:generateUploadUrl
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
parent
Required: Yes
Location: path
Type: string
Description: Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`.
Pattern: ^projects/[^/]+/locations/[^/]+$
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
▼ ▲ cloudfunctions.projects.locations.functions.patch
Path: v2alpha/{+name}
Description: Updates existing function.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}
Parameters:
name
Description: A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$
Type: string
updateMask
Description: The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
HTTP Method: PATCH
▼ ▲ cloudfunctions.projects.locations.list
Parameter Order: name
Flat Path: v2alpha/projects/{projectsId}/locations
Description: Lists information about the supported locations for this service.
Path: v2alpha/{+name}/locations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageSize
Format: int32
Location: query
Description: The maximum number of results to return. If not set, the service selects a default.
Type: integer
name
Location: path
Required: Yes
Type: string
Description: The resource that owns the locations collection, if applicable.
Pattern: ^projects/[^/]+$
filter
Location: query
Type: string
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageToken
Location: query
Type: string
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
HTTP Method: GET