xref: /aosp_15_r20/external/googleapis/google/cloud/functions/v1/cloudfunctions_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1type: google.api.Service
2config_version: 3
3name: cloudfunctions.googleapis.com
4title: Cloud Functions API
5
6apis:
7- name: google.cloud.functions.v1.CloudFunctionsService
8- name: google.cloud.location.Locations
9- name: google.iam.v1.IAMPolicy
10- name: google.longrunning.Operations
11
12types:
13- name: google.cloud.functions.v1.OperationMetadataV1
14
15documentation:
16  summary: 'Manages lightweight user-provided functions executed in response to events.'
17  overview: 'Manages lightweight user-provided functions executed in response to
18events.'
19  rules:
20  - selector: google.cloud.location.Locations.ListLocations
21    description: Lists information about the supported locations for this service.
22
23  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
24    description: |-
25      Gets the access control policy for a resource. Returns an empty policy
26      if the resource exists and does not have a policy set.
27
28  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
29    description: |-
30      Sets the access control policy on the specified resource. Replaces
31      any existing policy.
32
33      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
34      errors.
35
36  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
37    description: |-
38      Returns permissions that a caller has on the specified resource. If the
39      resource does not exist, this will return an empty set of
40      permissions, not a `NOT_FOUND` error.
41
42      Note: This operation is designed to be used for building
43      permission-aware UIs and command-line tools, not for authorization
44      checking. This operation may "fail open" without warning.
45
46http:
47  rules:
48  - selector: google.cloud.location.Locations.ListLocations
49    get: '/v1/{name=projects/*}/locations'
50  - selector: google.longrunning.Operations.GetOperation
51    get: '/v1/{name=operations/*}'
52  - selector: google.longrunning.Operations.ListOperations
53    get: /v1/operations
54
55authentication:
56  rules:
57  - selector: 'google.cloud.functions.v1.CloudFunctionsService.*'
58    oauth:
59      canonical_scopes: |-
60        https://www.googleapis.com/auth/cloud-platform
61  - selector: google.cloud.location.Locations.ListLocations
62    oauth:
63      canonical_scopes: |-
64        https://www.googleapis.com/auth/cloud-platform
65  - selector: 'google.iam.v1.IAMPolicy.*'
66    oauth:
67      canonical_scopes: |-
68        https://www.googleapis.com/auth/cloud-platform
69  - selector: 'google.longrunning.Operations.*'
70    oauth:
71      canonical_scopes: |-
72        https://www.googleapis.com/auth/cloud-platform
73