Cloud Functions API (cloudfunctions:v2)

2022-05-05

6 new methods | New API

Additions

    Methods
  • cloudfunctions.projects.locations.list

      HTTP Method : GET

      Path : v2/{+name}/locations

      Parameter Order : name

      Description : Lists information about the supported locations for this service.

      Parameters :

        pageToken

          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.

          Location : query

        name

          Description : The resource that owns the locations collection, if applicable.

          Required : Yes

          Location : path

          Pattern : ^projects/[^/]+$

          Type : string

        pageSize

          Location : query

          Type : integer

          Description : The maximum number of results to return. If not set, the service selects a default.

          Format : int32

        filter

          Type : string

          Location : query

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

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v2/projects/{projectsId}/locations

  • cloudfunctions.projects.locations.functions.testIamPermissions

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Parameter Order : resource

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions

      Path : v2/{+resource}:testIamPermissions

      HTTP Method : POST

      Parameters :

        resource

          Pattern : ^projects/[^/]+/locations/[^/]+/functions/[^/]+$

          Required : Yes

          Location : path

          Description : REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

          Type : string

      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.

  • cloudfunctions.projects.locations.functions.setIamPolicy

      Path : v2/{+resource}: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.

          Pattern : ^projects/[^/]+/locations/[^/]+/functions/[^/]+$

          Required : Yes

          Location : path

          Type : string

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

  • cloudfunctions.projects.locations.functions.getIamPolicy

      Parameters :

        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

        resource

          Description : REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

          Type : string

          Pattern : ^projects/[^/]+/locations/[^/]+/functions/[^/]+$

          Required : Yes

          Location : path

      Parameter Order : resource

      Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:getIamPolicy

      Path : v2/{+resource}:getIamPolicy

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : GET

  • cloudfunctions.projects.locations.operations.get

      HTTP Method : GET

      Parameter Order : name

      Parameters :

        name

          Description : The name of the operation resource.

          Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location : path

          Required : Yes

          Type : string

      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 : v2/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      Path : v2/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

  • cloudfunctions.projects.locations.operations.list

      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.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v2/projects/{projectsId}/locations/{locationsId}/operations

      Parameters :

        filter

          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

          Location : query

          Type : string

        pageSize

          Format : int32

          Location : query

          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.

          Type : integer

        pageToken

          Location : query

          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.

          Type : string

        name

          Description : Must not be set.

          Required : Yes

          Pattern : ^projects/[^/]+/locations/[^/]+$

          Location : path

          Type : string

      Parameter Order : name

      Path : v2/{+name}/operations

      HTTP Method : GET