v1.d.ts
16.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace bigtableadmin_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Bigtable Admin API
*
* Administer your Cloud Bigtable tables and instances.
*
* @example
* const {google} = require('googleapis');
* const bigtableadmin = google.bigtableadmin('v1');
*
* @namespace bigtableadmin
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Bigtableadmin
*/
class Bigtableadmin {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* A resizable group of nodes in a particular cloud location, capable of
* serving all Tables in the parent Instance.
*/
interface Schema$Cluster {
/**
* (`CreationOnly`) The type of storage used by this cluster to serve its
* parent instance's tables, unless explicitly overridden.
*/
defaultStorageType?: string;
/**
* (`CreationOnly`) The location where this cluster's nodes and storage
* reside. For best performance, clients should be located as close as
* possible to this cluster. Currently only zones are supported, so values
* should be of the form `projects/<project>/locations/<zone>`.
*/
location?: string;
/**
* (`OutputOnly`) The unique name of the cluster. Values are of the form
* `projects/<project>/instances/<instance>/clusters/a-z*`.
*/
name?: string;
/**
* The number of nodes allocated to this cluster. More nodes enable higher
* throughput and more consistent performance.
*/
serveNodes?: number;
/**
* (`OutputOnly`) The current state of the cluster.
*/
state?: string;
}
/**
* The metadata for the Operation returned by CreateCluster.
*/
interface Schema$CreateClusterMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this CreateCluster operation.
*/
originalRequest?: Schema$CreateClusterRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string;
/**
* Keys: the full `name` of each table that existed in the instance when
* CreateCluster was first called, i.e.
* `projects/<project>/instances/<instance>/tables/<table>`.
* Any table added to the instance by a later API call will be created in
* the new cluster by that API call, not this one. Values: information on
* how much of a table's data has been copied to the newly-created
* cluster so far.
*/
tables?: {
[key: string]: Schema$TableProgress;
};
}
/**
* Request message for BigtableInstanceAdmin.CreateCluster.
*/
interface Schema$CreateClusterRequest {
/**
* The cluster to be created. Fields marked `OutputOnly` must be left blank.
*/
cluster?: Schema$Cluster;
/**
* The ID to be used when referring to the new cluster within its instance,
* e.g., just `mycluster` rather than
* `projects/myproject/instances/myinstance/clusters/mycluster`.
*/
clusterId?: string;
/**
* The unique name of the instance in which to create the new cluster.
* Values are of the form
* `projects/<project>/instances/<instance>`.
*/
parent?: string;
}
/**
* The metadata for the Operation returned by CreateInstance.
*/
interface Schema$CreateInstanceMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this CreateInstance
* operation.
*/
originalRequest?: Schema$CreateInstanceRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string;
}
/**
* Request message for BigtableInstanceAdmin.CreateInstance.
*/
interface Schema$CreateInstanceRequest {
/**
* The clusters to be created within the instance, mapped by desired cluster
* ID, e.g., just `mycluster` rather than
* `projects/myproject/instances/myinstance/clusters/mycluster`. Fields
* marked `OutputOnly` must be left blank. Currently, at most two clusters
* can be specified.
*/
clusters?: {
[key: string]: Schema$Cluster;
};
/**
* The instance to create. Fields marked `OutputOnly` must be left blank.
*/
instance?: Schema$Instance;
/**
* The ID to be used when referring to the new instance within its project,
* e.g., just `myinstance` rather than
* `projects/myproject/instances/myinstance`.
*/
instanceId?: string;
/**
* The unique name of the project in which to create the new instance.
* Values are of the form `projects/<project>`.
*/
parent?: string;
}
/**
* A collection of Bigtable Tables and the resources that serve them. All
* tables in an instance are served from all Clusters in the instance.
*/
interface Schema$Instance {
/**
* The descriptive name for this instance as it appears in UIs. Can be
* changed at any time, but should be kept globally unique to avoid
* confusion.
*/
displayName?: string;
/**
* Labels are a flexible and lightweight mechanism for organizing cloud
* resources into groups that reflect a customer's organizational needs
* and deployment strategies. They can be used to filter resources and
* aggregate metrics. * Label keys must be between 1 and 63 characters long
* and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. *
* Label values must be between 0 and 63 characters long and must conform to
* the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64
* labels can be associated with a given resource. * Keys and values must
* both be under 128 bytes.
*/
labels?: {
[key: string]: string;
};
/**
* (`OutputOnly`) The unique name of the instance. Values are of the form
* `projects/<project>/instances/a-z+[a-z0-9]`.
*/
name?: string;
/**
* (`OutputOnly`) The current state of the instance.
*/
state?: string;
/**
* The type of the instance. Defaults to `PRODUCTION`.
*/
type?: string;
}
/**
* The response message for Locations.ListLocations.
*/
interface Schema$ListLocationsResponse {
/**
* A list of locations that matches the specified filter in the request.
*/
locations?: Schema$Location[];
/**
* The standard List next-page token.
*/
nextPageToken?: string;
}
/**
* A resource that represents Google Cloud Platform location.
*/
interface Schema$Location {
/**
* The friendly name for this location, typically a nearby city name. For
* example, "Tokyo".
*/
displayName?: string;
/**
* Cross-service attributes for the location. For example
* {"cloud.googleapis.com/region": "us-east1"}
*/
labels?: {
[key: string]: string;
};
/**
* The canonical id for this location. For example: `"us-east1"`.
*/
locationId?: string;
/**
* Service-specific metadata. For example the available capacity at the
* given location.
*/
metadata?: {
[key: string]: any;
};
/**
* Resource name for the location, which may vary between implementations.
* For example: `"projects/example-project/locations/us-east1"`
*/
name?: string;
}
/**
* Request message for BigtableInstanceAdmin.PartialUpdateInstance.
*/
interface Schema$PartialUpdateInstanceRequest {
/**
* The Instance which will (partially) replace the current value.
*/
instance?: Schema$Instance;
/**
* The subset of Instance fields which should be replaced. Must be
* explicitly set.
*/
updateMask?: string;
}
/**
* Progress info for copying a table's data to the new cluster.
*/
interface Schema$TableProgress {
/**
* Estimate of the number of bytes copied so far for this table. This will
* eventually reach 'estimated_size_bytes' unless the table copy is
* CANCELLED.
*/
estimatedCopiedBytes?: string;
/**
* Estimate of the size of the table to be copied.
*/
estimatedSizeBytes?: string;
state?: string;
}
/**
* The metadata for the Operation returned by UpdateAppProfile.
*/
interface Schema$UpdateAppProfileMetadata {
}
/**
* The metadata for the Operation returned by UpdateCluster.
*/
interface Schema$UpdateClusterMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this UpdateCluster operation.
*/
originalRequest?: Schema$Cluster;
/**
* The time at which the original request was received.
*/
requestTime?: string;
}
/**
* The metadata for the Operation returned by UpdateInstance.
*/
interface Schema$UpdateInstanceMetadata {
/**
* The time at which the operation failed or was completed successfully.
*/
finishTime?: string;
/**
* The request that prompted the initiation of this UpdateInstance
* operation.
*/
originalRequest?: Schema$PartialUpdateInstanceRequest;
/**
* The time at which the original request was received.
*/
requestTime?: string;
}
class Resource$Projects {
context: APIRequestContext;
locations: Resource$Projects$Locations;
constructor(context: APIRequestContext);
}
class Resource$Projects$Locations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* bigtableadmin.projects.locations.get
* @desc Gets information about a location.
* @alias bigtableadmin.projects.locations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Resource name for the location.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions): GaxiosPromise<Schema$Location>;
get(params: Params$Resource$Projects$Locations$Get, options: MethodOptions | BodyResponseCallback<Schema$Location>, callback: BodyResponseCallback<Schema$Location>): void;
get(params: Params$Resource$Projects$Locations$Get, callback: BodyResponseCallback<Schema$Location>): void;
get(callback: BodyResponseCallback<Schema$Location>): void;
/**
* bigtableadmin.projects.locations.list
* @desc Lists information about the supported locations for this service.
* @alias bigtableadmin.projects.locations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter The standard list filter.
* @param {string} params.name The resource that owns the locations collection, if applicable.
* @param {integer=} params.pageSize The standard list page size.
* @param {string=} params.pageToken The standard list page token.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Projects$Locations$List, options?: MethodOptions): GaxiosPromise<Schema$ListLocationsResponse>;
list(params: Params$Resource$Projects$Locations$List, options: MethodOptions | BodyResponseCallback<Schema$ListLocationsResponse>, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(params: Params$Resource$Projects$Locations$List, callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListLocationsResponse>): void;
}
interface Params$Resource$Projects$Locations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Resource name for the location.
*/
name?: string;
}
interface Params$Resource$Projects$Locations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The standard list filter.
*/
filter?: string;
/**
* The resource that owns the locations collection, if applicable.
*/
name?: string;
/**
* The standard list page size.
*/
pageSize?: number;
/**
* The standard list page token.
*/
pageToken?: string;
}
}