xref: /aosp_15_r20/external/googleapis/google/bigtable/admin/v2/bigtableadmin_v2.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1type: google.api.Service
2config_version: 3
3name: bigtableadmin.googleapis.com
4title: Cloud Bigtable Admin API
5
6apis:
7- name: google.bigtable.admin.v2.BigtableInstanceAdmin
8- name: google.bigtable.admin.v2.BigtableTableAdmin
9
10types:
11- name: google.bigtable.admin.v2.Backup
12- name: google.bigtable.admin.v2.CopyBackupMetadata
13- name: google.bigtable.admin.v2.CreateAuthorizedViewMetadata
14- name: google.bigtable.admin.v2.CreateBackupMetadata
15- name: google.bigtable.admin.v2.CreateClusterMetadata
16- name: google.bigtable.admin.v2.CreateInstanceMetadata
17- name: google.bigtable.admin.v2.CreateTableFromSnapshotMetadata
18- name: google.bigtable.admin.v2.OptimizeRestoredTableMetadata
19- name: google.bigtable.admin.v2.PartialUpdateClusterMetadata
20- name: google.bigtable.admin.v2.RestoreTableMetadata
21- name: google.bigtable.admin.v2.SnapshotTableMetadata
22- name: google.bigtable.admin.v2.UndeleteTableMetadata
23- name: google.bigtable.admin.v2.UpdateAppProfileMetadata
24- name: google.bigtable.admin.v2.UpdateAuthorizedViewMetadata
25- name: google.bigtable.admin.v2.UpdateClusterMetadata
26- name: google.bigtable.admin.v2.UpdateInstanceMetadata
27- name: google.bigtable.admin.v2.UpdateTableMetadata
28
29documentation:
30  summary: Administer your Cloud Bigtable tables and instances.
31
32backend:
33  rules:
34  - selector: 'google.bigtable.admin.v2.BigtableInstanceAdmin.*'
35    deadline: 60.0
36  - selector: 'google.bigtable.admin.v2.BigtableTableAdmin.*'
37    deadline: 60.0
38  - selector: google.bigtable.admin.v2.BigtableTableAdmin.CreateTable
39    deadline: 130.0
40  - selector: google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange
41    deadline: 900.0
42  - selector: 'google.longrunning.Operations.*'
43    deadline: 60.0
44
45http:
46  rules:
47  - selector: google.longrunning.Operations.CancelOperation
48    post: '/v2/{name=operations/**}:cancel'
49  - selector: google.longrunning.Operations.DeleteOperation
50    delete: '/v2/{name=operations/**}'
51  - selector: google.longrunning.Operations.GetOperation
52    get: '/v2/{name=operations/**}'
53  - selector: google.longrunning.Operations.ListOperations
54    get: '/v2/{name=operations/projects/**}/operations'
55
56authentication:
57  rules:
58  - selector: 'google.bigtable.admin.v2.BigtableInstanceAdmin.*'
59    oauth:
60      canonical_scopes: |-
61        https://www.googleapis.com/auth/bigtable.admin,
62        https://www.googleapis.com/auth/bigtable.admin.cluster,
63        https://www.googleapis.com/auth/bigtable.admin.instance,
64        https://www.googleapis.com/auth/cloud-bigtable.admin,
65        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
66        https://www.googleapis.com/auth/cloud-platform
67  - selector: google.bigtable.admin.v2.BigtableInstanceAdmin.GetAppProfile
68    oauth:
69      canonical_scopes: |-
70        https://www.googleapis.com/auth/bigtable.admin,
71        https://www.googleapis.com/auth/bigtable.admin.cluster,
72        https://www.googleapis.com/auth/bigtable.admin.instance,
73        https://www.googleapis.com/auth/cloud-bigtable.admin,
74        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
75        https://www.googleapis.com/auth/cloud-platform,
76        https://www.googleapis.com/auth/cloud-platform.read-only
77  - selector: google.bigtable.admin.v2.BigtableInstanceAdmin.GetCluster
78    oauth:
79      canonical_scopes: |-
80        https://www.googleapis.com/auth/bigtable.admin,
81        https://www.googleapis.com/auth/bigtable.admin.cluster,
82        https://www.googleapis.com/auth/bigtable.admin.instance,
83        https://www.googleapis.com/auth/cloud-bigtable.admin,
84        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
85        https://www.googleapis.com/auth/cloud-platform,
86        https://www.googleapis.com/auth/cloud-platform.read-only
87  - selector: google.bigtable.admin.v2.BigtableInstanceAdmin.GetInstance
88    oauth:
89      canonical_scopes: |-
90        https://www.googleapis.com/auth/bigtable.admin,
91        https://www.googleapis.com/auth/bigtable.admin.cluster,
92        https://www.googleapis.com/auth/bigtable.admin.instance,
93        https://www.googleapis.com/auth/cloud-bigtable.admin,
94        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
95        https://www.googleapis.com/auth/cloud-platform,
96        https://www.googleapis.com/auth/cloud-platform.read-only
97  - selector: google.bigtable.admin.v2.BigtableInstanceAdmin.ListClusters
98    oauth:
99      canonical_scopes: |-
100        https://www.googleapis.com/auth/bigtable.admin,
101        https://www.googleapis.com/auth/bigtable.admin.cluster,
102        https://www.googleapis.com/auth/bigtable.admin.instance,
103        https://www.googleapis.com/auth/cloud-bigtable.admin,
104        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
105        https://www.googleapis.com/auth/cloud-platform,
106        https://www.googleapis.com/auth/cloud-platform.read-only
107  - selector: google.bigtable.admin.v2.BigtableInstanceAdmin.ListHotTablets
108    oauth:
109      canonical_scopes: |-
110        https://www.googleapis.com/auth/bigtable.admin,
111        https://www.googleapis.com/auth/bigtable.admin.cluster,
112        https://www.googleapis.com/auth/bigtable.admin.instance,
113        https://www.googleapis.com/auth/cloud-bigtable.admin,
114        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
115        https://www.googleapis.com/auth/cloud-platform,
116        https://www.googleapis.com/auth/cloud-platform.read-only
117  - selector: google.bigtable.admin.v2.BigtableInstanceAdmin.ListInstances
118    oauth:
119      canonical_scopes: |-
120        https://www.googleapis.com/auth/bigtable.admin,
121        https://www.googleapis.com/auth/bigtable.admin.cluster,
122        https://www.googleapis.com/auth/bigtable.admin.instance,
123        https://www.googleapis.com/auth/cloud-bigtable.admin,
124        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
125        https://www.googleapis.com/auth/cloud-platform,
126        https://www.googleapis.com/auth/cloud-platform.read-only
127  - selector: 'google.bigtable.admin.v2.BigtableTableAdmin.*'
128    oauth:
129      canonical_scopes: |-
130        https://www.googleapis.com/auth/bigtable.admin,
131        https://www.googleapis.com/auth/bigtable.admin.table,
132        https://www.googleapis.com/auth/cloud-bigtable.admin,
133        https://www.googleapis.com/auth/cloud-bigtable.admin.table,
134        https://www.googleapis.com/auth/cloud-platform
135  - selector: google.bigtable.admin.v2.BigtableTableAdmin.GetTable
136    oauth:
137      canonical_scopes: |-
138        https://www.googleapis.com/auth/bigtable.admin,
139        https://www.googleapis.com/auth/bigtable.admin.table,
140        https://www.googleapis.com/auth/cloud-bigtable.admin,
141        https://www.googleapis.com/auth/cloud-bigtable.admin.table,
142        https://www.googleapis.com/auth/cloud-platform,
143        https://www.googleapis.com/auth/cloud-platform.read-only
144  - selector: google.bigtable.admin.v2.BigtableTableAdmin.ListTables
145    oauth:
146      canonical_scopes: |-
147        https://www.googleapis.com/auth/bigtable.admin,
148        https://www.googleapis.com/auth/bigtable.admin.table,
149        https://www.googleapis.com/auth/cloud-bigtable.admin,
150        https://www.googleapis.com/auth/cloud-bigtable.admin.table,
151        https://www.googleapis.com/auth/cloud-platform,
152        https://www.googleapis.com/auth/cloud-platform.read-only
153  - selector: 'google.longrunning.Operations.*'
154    oauth:
155      canonical_scopes: |-
156        https://www.googleapis.com/auth/bigtable.admin,
157        https://www.googleapis.com/auth/bigtable.admin.cluster,
158        https://www.googleapis.com/auth/bigtable.admin.instance,
159        https://www.googleapis.com/auth/cloud-bigtable.admin,
160        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
161        https://www.googleapis.com/auth/cloud-platform
162  - selector: google.longrunning.Operations.GetOperation
163    oauth:
164      canonical_scopes: |-
165        https://www.googleapis.com/auth/bigtable.admin,
166        https://www.googleapis.com/auth/bigtable.admin.cluster,
167        https://www.googleapis.com/auth/bigtable.admin.instance,
168        https://www.googleapis.com/auth/cloud-bigtable.admin,
169        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
170        https://www.googleapis.com/auth/cloud-platform,
171        https://www.googleapis.com/auth/cloud-platform.read-only
172  - selector: google.longrunning.Operations.ListOperations
173    oauth:
174      canonical_scopes: |-
175        https://www.googleapis.com/auth/bigtable.admin,
176        https://www.googleapis.com/auth/bigtable.admin.cluster,
177        https://www.googleapis.com/auth/bigtable.admin.instance,
178        https://www.googleapis.com/auth/cloud-bigtable.admin,
179        https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,
180        https://www.googleapis.com/auth/cloud-platform,
181        https://www.googleapis.com/auth/cloud-platform.read-only
182