xref: /aosp_15_r20/external/googleapis/google/cloud/notebooks/v1/notebooks_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1type: google.api.Service
2config_version: 3
3name: notebooks.googleapis.com
4title: Notebooks API
5
6apis:
7- name: google.cloud.location.Locations
8- name: google.cloud.notebooks.v1.ManagedNotebookService
9- name: google.cloud.notebooks.v1.NotebookService
10- name: google.iam.v1.IAMPolicy
11- name: google.longrunning.Operations
12
13types:
14- name: google.cloud.notebooks.v1.OperationMetadata
15
16documentation:
17  summary: Notebooks API is used to manage notebook resources in Google Cloud.
18  rules:
19  - selector: google.cloud.location.Locations.GetLocation
20    description: Gets information about a location.
21
22  - selector: google.cloud.location.Locations.ListLocations
23    description: Lists information about the supported locations for this service.
24
25  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
26    description: |-
27      Gets the access control policy for a resource. Returns an empty policy
28      if the resource exists and does not have a policy set.
29
30  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
31    description: |-
32      Sets the access control policy on the specified resource. Replaces
33      any existing policy.
34
35      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
36      errors.
37
38  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
39    description: |-
40      Returns permissions that a caller has on the specified resource. If the
41      resource does not exist, this will return an empty set of
42      permissions, not a `NOT_FOUND` error.
43
44      Note: This operation is designed to be used for building
45      permission-aware UIs and command-line tools, not for authorization
46      checking. This operation may "fail open" without warning.
47
48backend:
49  rules:
50  - selector: google.cloud.location.Locations.GetLocation
51    deadline: 60.0
52  - selector: google.cloud.location.Locations.ListLocations
53    deadline: 60.0
54  - selector: 'google.cloud.notebooks.v1.ManagedNotebookService.*'
55    deadline: 60.0
56  - selector: 'google.cloud.notebooks.v1.NotebookService.*'
57    deadline: 60.0
58  - selector: 'google.iam.v1.IAMPolicy.*'
59    deadline: 60.0
60  - selector: 'google.longrunning.Operations.*'
61    deadline: 60.0
62  - selector: google.longrunning.Operations.GetOperation
63    deadline: 5.0
64
65http:
66  rules:
67  - selector: google.cloud.location.Locations.GetLocation
68    get: '/v1/{name=projects/*/locations/*}'
69  - selector: google.cloud.location.Locations.ListLocations
70    get: '/v1/{name=projects/*}/locations'
71  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
72    get: '/v1/{resource=projects/*/locations/*/instances/*}:getIamPolicy'
73    additional_bindings:
74    - get: '/v1/{resource=projects/*/locations/*/runtimes/*}:getIamPolicy'
75  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
76    post: '/v1/{resource=projects/*/locations/*/instances/*}:setIamPolicy'
77    body: '*'
78    additional_bindings:
79    - post: '/v1/{resource=projects/*/locations/*/runtimes/*}:setIamPolicy'
80      body: '*'
81  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
82    post: '/v1/{resource=projects/*/locations/*/instances/*}:testIamPermissions'
83    body: '*'
84    additional_bindings:
85    - post: '/v1/{resource=projects/*/locations/*/runtimes/*}:testIamPermissions'
86      body: '*'
87  - selector: google.longrunning.Operations.CancelOperation
88    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
89    body: '*'
90  - selector: google.longrunning.Operations.DeleteOperation
91    delete: '/v1/{name=projects/*/locations/*/operations/*}'
92  - selector: google.longrunning.Operations.GetOperation
93    get: '/v1/{name=projects/*/locations/*/operations/*}'
94  - selector: google.longrunning.Operations.ListOperations
95    get: '/v1/{name=projects/*/locations/*}/operations'
96
97authentication:
98  rules:
99  - selector: google.cloud.location.Locations.GetLocation
100    oauth:
101      canonical_scopes: |-
102        https://www.googleapis.com/auth/cloud-platform
103  - selector: google.cloud.location.Locations.ListLocations
104    oauth:
105      canonical_scopes: |-
106        https://www.googleapis.com/auth/cloud-platform
107  - selector: 'google.cloud.notebooks.v1.ManagedNotebookService.*'
108    oauth:
109      canonical_scopes: |-
110        https://www.googleapis.com/auth/cloud-platform
111  - selector: 'google.cloud.notebooks.v1.NotebookService.*'
112    oauth:
113      canonical_scopes: |-
114        https://www.googleapis.com/auth/cloud-platform
115  - selector: 'google.iam.v1.IAMPolicy.*'
116    oauth:
117      canonical_scopes: |-
118        https://www.googleapis.com/auth/cloud-platform
119  - selector: 'google.longrunning.Operations.*'
120    oauth:
121      canonical_scopes: |-
122        https://www.googleapis.com/auth/cloud-platform
123