xref: /aosp_15_r20/external/googleapis/google/cloud/functions/v2/cloudfunctions_v2.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.v2.FunctionService
8- name: google.cloud.location.Locations
9- name: google.iam.v1.IAMPolicy
10- name: google.longrunning.Operations
11
12types:
13- name: google.cloud.functions.v2.LocationMetadata
14- name: google.cloud.functions.v2.OperationMetadata
15
16documentation:
17  summary: 'Manages lightweight user-provided functions executed in response to events.'
18  overview: 'Manages lightweight user-provided functions executed in response to
19events.'
20  rules:
21  - selector: google.cloud.location.Locations.ListLocations
22    description: Lists information about the supported locations for this service.
23
24  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
25    description: |-
26      Gets the access control policy for a resource. Returns an empty policy
27      if the resource exists and does not have a policy set.
28
29  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
30    description: |-
31      Sets the access control policy on the specified resource. Replaces
32      any existing policy.
33
34      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
35      errors.
36
37  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
38    description: |-
39      Returns permissions that a caller has on the specified resource. If the
40      resource does not exist, this will return an empty set of
41      permissions, not a `NOT_FOUND` error.
42
43      Note: This operation is designed to be used for building
44      permission-aware UIs and command-line tools, not for authorization
45      checking. This operation may "fail open" without warning.
46
47backend:
48  rules:
49  - selector: 'google.cloud.functions.v2.FunctionService.*'
50    deadline: 30.0
51  - selector: google.cloud.location.Locations.ListLocations
52    deadline: 30.0
53  - selector: 'google.iam.v1.IAMPolicy.*'
54    deadline: 30.0
55  - selector: 'google.longrunning.Operations.*'
56    deadline: 30.0
57
58http:
59  rules:
60  - selector: google.cloud.location.Locations.ListLocations
61    get: '/v2/{name=projects/*}/locations'
62  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
63    get: '/v2/{resource=projects/*/locations/*/functions/*}:getIamPolicy'
64  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
65    post: '/v2/{resource=projects/*/locations/*/functions/*}:setIamPolicy'
66    body: '*'
67  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
68    post: '/v2/{resource=projects/*/locations/*/functions/*}:testIamPermissions'
69    body: '*'
70  - selector: google.longrunning.Operations.GetOperation
71    get: '/v2/{name=projects/*/locations/*/operations/*}'
72  - selector: google.longrunning.Operations.ListOperations
73    get: '/v2/{name=projects/*/locations/*}/operations'
74
75authentication:
76  rules:
77  - selector: 'google.cloud.functions.v2.FunctionService.*'
78    oauth:
79      canonical_scopes: |-
80        https://www.googleapis.com/auth/cloud-platform
81  - selector: google.cloud.location.Locations.ListLocations
82    oauth:
83      canonical_scopes: |-
84        https://www.googleapis.com/auth/cloud-platform
85  - selector: 'google.iam.v1.IAMPolicy.*'
86    oauth:
87      canonical_scopes: |-
88        https://www.googleapis.com/auth/cloud-platform
89  - selector: 'google.longrunning.Operations.*'
90    oauth:
91      canonical_scopes: |-
92        https://www.googleapis.com/auth/cloud-platform
93