xref: /aosp_15_r20/external/googleapis/google/cloud/notebooks/v2/notebooks_v2.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.v2.NotebookService
9- name: google.iam.v1.IAMPolicy
10- name: google.longrunning.Operations
11
12types:
13- name: google.cloud.notebooks.v2.OperationMetadata
14
15documentation:
16  summary: Notebooks API is used to manage notebook resources in Google Cloud.
17  rules:
18  - selector: google.cloud.location.Locations.GetLocation
19    description: Gets information about a location.
20
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.location.Locations.GetLocation
50    deadline: 60.0
51  - selector: google.cloud.location.Locations.ListLocations
52    deadline: 60.0
53  - selector: 'google.cloud.notebooks.v2.NotebookService.*'
54    deadline: 60.0
55  - selector: 'google.iam.v1.IAMPolicy.*'
56    deadline: 60.0
57  - selector: 'google.longrunning.Operations.*'
58    deadline: 60.0
59  - selector: google.longrunning.Operations.GetOperation
60    deadline: 5.0
61
62http:
63  rules:
64  - selector: google.cloud.location.Locations.GetLocation
65    get: '/v2/{name=projects/*/locations/*}'
66  - selector: google.cloud.location.Locations.ListLocations
67    get: '/v2/{name=projects/*}/locations'
68  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
69    get: '/v2/{resource=projects/*/locations/*/instances/*}:getIamPolicy'
70  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
71    post: '/v2/{resource=projects/*/locations/*/instances/*}:setIamPolicy'
72    body: '*'
73  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
74    post: '/v2/{resource=projects/*/locations/*/instances/*}:testIamPermissions'
75    body: '*'
76  - selector: google.longrunning.Operations.CancelOperation
77    post: '/v2/{name=projects/*/locations/*/operations/*}:cancel'
78    body: '*'
79  - selector: google.longrunning.Operations.DeleteOperation
80    delete: '/v2/{name=projects/*/locations/*/operations/*}'
81  - selector: google.longrunning.Operations.GetOperation
82    get: '/v2/{name=projects/*/locations/*/operations/*}'
83  - selector: google.longrunning.Operations.ListOperations
84    get: '/v2/{name=projects/*/locations/*}/operations'
85
86authentication:
87  rules:
88  - selector: google.cloud.location.Locations.GetLocation
89    oauth:
90      canonical_scopes: |-
91        https://www.googleapis.com/auth/cloud-platform
92  - selector: google.cloud.location.Locations.ListLocations
93    oauth:
94      canonical_scopes: |-
95        https://www.googleapis.com/auth/cloud-platform
96  - selector: 'google.cloud.notebooks.v2.NotebookService.*'
97    oauth:
98      canonical_scopes: |-
99        https://www.googleapis.com/auth/cloud-platform
100  - selector: 'google.iam.v1.IAMPolicy.*'
101    oauth:
102      canonical_scopes: |-
103        https://www.googleapis.com/auth/cloud-platform
104  - selector: 'google.longrunning.Operations.*'
105    oauth:
106      canonical_scopes: |-
107        https://www.googleapis.com/auth/cloud-platform
108
109publishing:
110  new_issue_uri: https://issuetracker.google.com/issues/new?component=1392625
111  documentation_uri: https://cloud.google.com/vertex-ai/docs/workbench/instances/introduction
112  api_short_name: notebooks
113  github_label: 'api: notebooks'
114  doc_tag_prefix: notebooks
115  organization: CLOUD
116  library_settings:
117  - version: google.cloud.notebooks.v2
118    launch_stage: GA
119    java_settings:
120      common:
121        destinations:
122        - PACKAGE_MANAGER
123    cpp_settings:
124      common:
125        destinations:
126        - PACKAGE_MANAGER
127    php_settings:
128      common:
129        destinations:
130        - PACKAGE_MANAGER
131    python_settings:
132      common:
133        destinations:
134        - PACKAGE_MANAGER
135    node_settings:
136      common:
137        destinations:
138        - PACKAGE_MANAGER
139    dotnet_settings:
140      common:
141        destinations:
142        - PACKAGE_MANAGER
143    ruby_settings:
144      common:
145        destinations:
146        - PACKAGE_MANAGER
147    go_settings:
148      common:
149        destinations:
150        - PACKAGE_MANAGER
151  proto_reference_documentation_uri: https://cloud.google.com/vertex-ai/docs/workbench/reference/rest
152