-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
bigtable_instance_admin.proto
751 lines (652 loc) · 27.9 KB
/
bigtable_instance_admin.proto
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
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
// Copyright 2023 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.
syntax = "proto3";
package google.bigtable.admin.v2;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/bigtable/admin/v2/instance.proto";
import "google/iam/v1/iam_policy.proto";
import "google/iam/v1/policy.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
option java_multiple_files = true;
option java_outer_classname = "BigtableInstanceAdminProto";
option java_package = "com.google.bigtable.admin.v2";
option php_namespace = "Google\\Cloud\\Bigtable\\Admin\\V2";
option ruby_package = "Google::Cloud::Bigtable::Admin::V2";
// Service for creating, configuring, and deleting Cloud Bigtable Instances and
// Clusters. Provides access to the Instance and Cluster schemas only, not the
// tables' metadata or data stored in those tables.
service BigtableInstanceAdmin {
option (google.api.default_host) = "bigtableadmin.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/bigtable.admin,"
"https://www.googleapis.com/auth/bigtable.admin.cluster,"
"https://www.googleapis.com/auth/bigtable.admin.instance,"
"https://www.googleapis.com/auth/cloud-bigtable.admin,"
"https://www.googleapis.com/auth/cloud-bigtable.admin.cluster,"
"https://www.googleapis.com/auth/cloud-platform,"
"https://www.googleapis.com/auth/cloud-platform.read-only";
// Create an instance within a project.
//
// Note that exactly one of Cluster.serve_nodes and
// Cluster.cluster_config.cluster_autoscaling_config can be set. If
// serve_nodes is set to non-zero, then the cluster is manually scaled. If
// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
// enabled.
rpc CreateInstance(CreateInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{parent=projects/*}/instances"
body: "*"
};
option (google.api.method_signature) =
"parent,instance_id,instance,clusters";
option (google.longrunning.operation_info) = {
response_type: "Instance"
metadata_type: "CreateInstanceMetadata"
};
}
// Gets information about an instance.
rpc GetInstance(GetInstanceRequest) returns (Instance) {
option (google.api.http) = {
get: "/v2/{name=projects/*/instances/*}"
};
option (google.api.method_signature) = "name";
}
// Lists information about instances in a project.
rpc ListInstances(ListInstancesRequest) returns (ListInstancesResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*}/instances"
};
option (google.api.method_signature) = "parent";
}
// Updates an instance within a project. This method updates only the display
// name and type for an Instance. To update other Instance properties, such as
// labels, use PartialUpdateInstance.
rpc UpdateInstance(Instance) returns (Instance) {
option (google.api.http) = {
put: "/v2/{name=projects/*/instances/*}"
body: "*"
};
}
// Partially updates an instance within a project. This method can modify all
// fields of an Instance and is the preferred way to update an Instance.
rpc PartialUpdateInstance(PartialUpdateInstanceRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v2/{instance.name=projects/*/instances/*}"
body: "instance"
};
option (google.api.method_signature) = "instance,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Instance"
metadata_type: "UpdateInstanceMetadata"
};
}
// Delete an instance from a project.
rpc DeleteInstance(DeleteInstanceRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{name=projects/*/instances/*}"
};
option (google.api.method_signature) = "name";
}
// Creates a cluster within an instance.
//
// Note that exactly one of Cluster.serve_nodes and
// Cluster.cluster_config.cluster_autoscaling_config can be set. If
// serve_nodes is set to non-zero, then the cluster is manually scaled. If
// cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
// enabled.
rpc CreateCluster(CreateClusterRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/instances/*}/clusters"
body: "cluster"
};
option (google.api.method_signature) = "parent,cluster_id,cluster";
option (google.longrunning.operation_info) = {
response_type: "Cluster"
metadata_type: "CreateClusterMetadata"
};
}
// Gets information about a cluster.
rpc GetCluster(GetClusterRequest) returns (Cluster) {
option (google.api.http) = {
get: "/v2/{name=projects/*/instances/*/clusters/*}"
};
option (google.api.method_signature) = "name";
}
// Lists information about clusters in an instance.
rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*/instances/*}/clusters"
};
option (google.api.method_signature) = "parent";
}
// Updates a cluster within an instance.
//
// Note that UpdateCluster does not support updating
// cluster_config.cluster_autoscaling_config. In order to update it, you
// must use PartialUpdateCluster.
rpc UpdateCluster(Cluster) returns (google.longrunning.Operation) {
option (google.api.http) = {
put: "/v2/{name=projects/*/instances/*/clusters/*}"
body: "*"
};
option (google.longrunning.operation_info) = {
response_type: "Cluster"
metadata_type: "UpdateClusterMetadata"
};
}
// Partially updates a cluster within a project. This method is the preferred
// way to update a Cluster.
//
// To enable and update autoscaling, set
// cluster_config.cluster_autoscaling_config. When autoscaling is enabled,
// serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it
// are ignored. Note that an update cannot simultaneously set serve_nodes to
// non-zero and cluster_config.cluster_autoscaling_config to non-empty, and
// also specify both in the update_mask.
//
// To disable autoscaling, clear cluster_config.cluster_autoscaling_config,
// and explicitly set a serve_node count via the update_mask.
rpc PartialUpdateCluster(PartialUpdateClusterRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v2/{cluster.name=projects/*/instances/*/clusters/*}"
body: "cluster"
};
option (google.api.method_signature) = "cluster,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Cluster"
metadata_type: "PartialUpdateClusterMetadata"
};
}
// Deletes a cluster from an instance.
rpc DeleteCluster(DeleteClusterRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{name=projects/*/instances/*/clusters/*}"
};
option (google.api.method_signature) = "name";
}
// Creates an app profile within an instance.
rpc CreateAppProfile(CreateAppProfileRequest) returns (AppProfile) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/instances/*}/appProfiles"
body: "app_profile"
};
option (google.api.method_signature) = "parent,app_profile_id,app_profile";
}
// Gets information about an app profile.
rpc GetAppProfile(GetAppProfileRequest) returns (AppProfile) {
option (google.api.http) = {
get: "/v2/{name=projects/*/instances/*/appProfiles/*}"
};
option (google.api.method_signature) = "name";
}
// Lists information about app profiles in an instance.
rpc ListAppProfiles(ListAppProfilesRequest)
returns (ListAppProfilesResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*/instances/*}/appProfiles"
};
option (google.api.method_signature) = "parent";
}
// Updates an app profile within an instance.
rpc UpdateAppProfile(UpdateAppProfileRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v2/{app_profile.name=projects/*/instances/*/appProfiles/*}"
body: "app_profile"
};
option (google.api.method_signature) = "app_profile,update_mask";
option (google.longrunning.operation_info) = {
response_type: "AppProfile"
metadata_type: "UpdateAppProfileMetadata"
};
}
// Deletes an app profile from an instance.
rpc DeleteAppProfile(DeleteAppProfileRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{name=projects/*/instances/*/appProfiles/*}"
};
option (google.api.method_signature) = "name";
}
// Gets the access control policy for an instance resource. Returns an empty
// policy if an instance exists but does not have a policy set.
rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v2/{resource=projects/*/instances/*}:getIamPolicy"
body: "*"
};
option (google.api.method_signature) = "resource";
}
// Sets the access control policy on an instance resource. Replaces any
// existing policy.
rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
returns (google.iam.v1.Policy) {
option (google.api.http) = {
post: "/v2/{resource=projects/*/instances/*}:setIamPolicy"
body: "*"
};
option (google.api.method_signature) = "resource,policy";
}
// Returns permissions that the caller has on the specified instance resource.
rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
returns (google.iam.v1.TestIamPermissionsResponse) {
option (google.api.http) = {
post: "/v2/{resource=projects/*/instances/*}:testIamPermissions"
body: "*"
};
option (google.api.method_signature) = "resource,permissions";
}
// Lists hot tablets in a cluster, within the time range provided. Hot
// tablets are ordered based on CPU usage.
rpc ListHotTablets(ListHotTabletsRequest) returns (ListHotTabletsResponse) {
option (google.api.http) = {
get: "/v2/{parent=projects/*/instances/*/clusters/*}/hotTablets"
};
option (google.api.method_signature) = "parent";
}
}
// Request message for BigtableInstanceAdmin.CreateInstance.
message CreateInstanceRequest {
// Required. The unique name of the project in which to create the new
// instance. Values are of the form `projects/{project}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "cloudresourcemanager.googleapis.com/Project"
}
];
// Required. The ID to be used when referring to the new instance within its
// project, e.g., just `myinstance` rather than
// `projects/myproject/instances/myinstance`.
string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The instance to create.
// Fields marked `OutputOnly` must be left blank.
Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
// Required. 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 four clusters can be specified.
map<string, Cluster> clusters = 4 [(google.api.field_behavior) = REQUIRED];
}
// Request message for BigtableInstanceAdmin.GetInstance.
message GetInstanceRequest {
// Required. The unique name of the requested instance. Values are of the form
// `projects/{project}/instances/{instance}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Instance"
}
];
}
// Request message for BigtableInstanceAdmin.ListInstances.
message ListInstancesRequest {
// Required. The unique name of the project for which a list of instances is
// requested. Values are of the form `projects/{project}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "cloudresourcemanager.googleapis.com/Project"
}
];
// DEPRECATED: This field is unused and ignored.
string page_token = 2;
}
// Response message for BigtableInstanceAdmin.ListInstances.
message ListInstancesResponse {
// The list of requested instances.
repeated Instance instances = 1;
// Locations from which Instance information could not be retrieved,
// due to an outage or some other transient condition.
// Instances whose Clusters are all in one of the failed locations
// may be missing from `instances`, and Instances with at least one
// Cluster in a failed location may only have partial information returned.
// Values are of the form `projects/<project>/locations/<zone_id>`
repeated string failed_locations = 2;
// DEPRECATED: This field is unused and ignored.
string next_page_token = 3;
}
// Request message for BigtableInstanceAdmin.PartialUpdateInstance.
message PartialUpdateInstanceRequest {
// Required. The Instance which will (partially) replace the current value.
Instance instance = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The subset of Instance fields which should be replaced.
// Must be explicitly set.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// Request message for BigtableInstanceAdmin.DeleteInstance.
message DeleteInstanceRequest {
// Required. The unique name of the instance to be deleted.
// Values are of the form `projects/{project}/instances/{instance}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Instance"
}
];
}
// Request message for BigtableInstanceAdmin.CreateCluster.
message CreateClusterRequest {
// Required. The unique name of the instance in which to create the new
// cluster. Values are of the form `projects/{project}/instances/{instance}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Instance"
}
];
// Required. 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`.
string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The cluster to be created.
// Fields marked `OutputOnly` must be left blank.
Cluster cluster = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for BigtableInstanceAdmin.GetCluster.
message GetClusterRequest {
// Required. The unique name of the requested cluster. Values are of the form
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Cluster"
}
];
}
// Request message for BigtableInstanceAdmin.ListClusters.
message ListClustersRequest {
// Required. The unique name of the instance for which a list of clusters is
// requested. Values are of the form
// `projects/{project}/instances/{instance}`. Use `{instance} = '-'` to list
// Clusters for all Instances in a project, e.g.,
// `projects/myproject/instances/-`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Instance"
}
];
// DEPRECATED: This field is unused and ignored.
string page_token = 2;
}
// Response message for BigtableInstanceAdmin.ListClusters.
message ListClustersResponse {
// The list of requested clusters.
repeated Cluster clusters = 1;
// Locations from which Cluster information could not be retrieved,
// due to an outage or some other transient condition.
// Clusters from these locations may be missing from `clusters`,
// or may only have partial information returned.
// Values are of the form `projects/<project>/locations/<zone_id>`
repeated string failed_locations = 2;
// DEPRECATED: This field is unused and ignored.
string next_page_token = 3;
}
// Request message for BigtableInstanceAdmin.DeleteCluster.
message DeleteClusterRequest {
// Required. The unique name of the cluster to be deleted. Values are of the
// form `projects/{project}/instances/{instance}/clusters/{cluster}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Cluster"
}
];
}
// The metadata for the Operation returned by CreateInstance.
message CreateInstanceMetadata {
// The request that prompted the initiation of this CreateInstance operation.
CreateInstanceRequest original_request = 1;
// The time at which the original request was received.
google.protobuf.Timestamp request_time = 2;
// The time at which the operation failed or was completed successfully.
google.protobuf.Timestamp finish_time = 3;
}
// The metadata for the Operation returned by UpdateInstance.
message UpdateInstanceMetadata {
// The request that prompted the initiation of this UpdateInstance operation.
PartialUpdateInstanceRequest original_request = 1;
// The time at which the original request was received.
google.protobuf.Timestamp request_time = 2;
// The time at which the operation failed or was completed successfully.
google.protobuf.Timestamp finish_time = 3;
}
// The metadata for the Operation returned by CreateCluster.
message CreateClusterMetadata {
// Progress info for copying a table's data to the new cluster.
message TableProgress {
enum State {
STATE_UNSPECIFIED = 0;
// The table has not yet begun copying to the new cluster.
PENDING = 1;
// The table is actively being copied to the new cluster.
COPYING = 2;
// The table has been fully copied to the new cluster.
COMPLETED = 3;
// The table was deleted before it finished copying to the new cluster.
// Note that tables deleted after completion will stay marked as
// COMPLETED, not CANCELLED.
CANCELLED = 4;
}
// Estimate of the size of the table to be copied.
int64 estimated_size_bytes = 2;
// 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.
int64 estimated_copied_bytes = 3;
State state = 4;
}
// The request that prompted the initiation of this CreateCluster operation.
CreateClusterRequest original_request = 1;
// The time at which the original request was received.
google.protobuf.Timestamp request_time = 2;
// The time at which the operation failed or was completed successfully.
google.protobuf.Timestamp finish_time = 3;
// 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.
map<string, TableProgress> tables = 4;
}
// The metadata for the Operation returned by UpdateCluster.
message UpdateClusterMetadata {
// The request that prompted the initiation of this UpdateCluster operation.
Cluster original_request = 1;
// The time at which the original request was received.
google.protobuf.Timestamp request_time = 2;
// The time at which the operation failed or was completed successfully.
google.protobuf.Timestamp finish_time = 3;
}
// The metadata for the Operation returned by PartialUpdateCluster.
message PartialUpdateClusterMetadata {
// The time at which the original request was received.
google.protobuf.Timestamp request_time = 1;
// The time at which the operation failed or was completed successfully.
google.protobuf.Timestamp finish_time = 2;
// The original request for PartialUpdateCluster.
PartialUpdateClusterRequest original_request = 3;
}
// Request message for BigtableInstanceAdmin.PartialUpdateCluster.
message PartialUpdateClusterRequest {
// Required. The Cluster which contains the partial updates to be applied,
// subject to the update_mask.
Cluster cluster = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The subset of Cluster fields which should be replaced.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
}
// Request message for BigtableInstanceAdmin.CreateAppProfile.
message CreateAppProfileRequest {
// Required. The unique name of the instance in which to create the new app
// profile. Values are of the form `projects/{project}/instances/{instance}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Instance"
}
];
// Required. The ID to be used when referring to the new app profile within
// its instance, e.g., just `myprofile` rather than
// `projects/myproject/instances/myinstance/appProfiles/myprofile`.
string app_profile_id = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The app profile to be created.
// Fields marked `OutputOnly` will be ignored.
AppProfile app_profile = 3 [(google.api.field_behavior) = REQUIRED];
// If true, ignore safety checks when creating the app profile.
bool ignore_warnings = 4;
}
// Request message for BigtableInstanceAdmin.GetAppProfile.
message GetAppProfileRequest {
// Required. The unique name of the requested app profile. Values are of the
// form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/AppProfile"
}
];
}
// Request message for BigtableInstanceAdmin.ListAppProfiles.
message ListAppProfilesRequest {
// Required. The unique name of the instance for which a list of app profiles
// is requested. Values are of the form
// `projects/{project}/instances/{instance}`.
// Use `{instance} = '-'` to list AppProfiles for all Instances in a project,
// e.g., `projects/myproject/instances/-`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Instance"
}
];
// Maximum number of results per page.
//
// A page_size of zero lets the server choose the number of items to return.
// A page_size which is strictly positive will return at most that many items.
// A negative page_size will cause an error.
//
// Following the first request, subsequent paginated calls are not required
// to pass a page_size. If a page_size is set in subsequent calls, it must
// match the page_size given in the first request.
int32 page_size = 3;
// The value of `next_page_token` returned by a previous call.
string page_token = 2;
}
// Response message for BigtableInstanceAdmin.ListAppProfiles.
message ListAppProfilesResponse {
// The list of requested app profiles.
repeated AppProfile app_profiles = 1;
// Set if not all app profiles could be returned in a single response.
// Pass this value to `page_token` in another request to get the next
// page of results.
string next_page_token = 2;
// Locations from which AppProfile information could not be retrieved,
// due to an outage or some other transient condition.
// AppProfiles from these locations may be missing from `app_profiles`.
// Values are of the form `projects/<project>/locations/<zone_id>`
repeated string failed_locations = 3;
}
// Request message for BigtableInstanceAdmin.UpdateAppProfile.
message UpdateAppProfileRequest {
// Required. The app profile which will (partially) replace the current value.
AppProfile app_profile = 1 [(google.api.field_behavior) = REQUIRED];
// Required. The subset of app profile fields which should be replaced.
// If unset, all fields will be replaced.
google.protobuf.FieldMask update_mask = 2
[(google.api.field_behavior) = REQUIRED];
// If true, ignore safety checks when updating the app profile.
bool ignore_warnings = 3;
}
// Request message for BigtableInstanceAdmin.DeleteAppProfile.
message DeleteAppProfileRequest {
// Required. The unique name of the app profile to be deleted. Values are of
// the form
// `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/AppProfile"
}
];
// Required. If true, ignore safety checks when deleting the app profile.
bool ignore_warnings = 2 [(google.api.field_behavior) = REQUIRED];
}
// The metadata for the Operation returned by UpdateAppProfile.
message UpdateAppProfileMetadata {}
// Request message for BigtableInstanceAdmin.ListHotTablets.
message ListHotTabletsRequest {
// Required. The cluster name to list hot tablets.
// Value is in the following form:
// `projects/{project}/instances/{instance}/clusters/{cluster}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "bigtableadmin.googleapis.com/Cluster"
}
];
// The start time to list hot tablets. The hot tablets in the response will
// have start times between the requested start time and end time. Start time
// defaults to Now if it is unset, and end time defaults to Now - 24 hours if
// it is unset. The start time should be less than the end time, and the
// maximum allowed time range between start time and end time is 48 hours.
// Start time and end time should have values between Now and Now - 14 days.
google.protobuf.Timestamp start_time = 2;
// The end time to list hot tablets.
google.protobuf.Timestamp end_time = 3;
// Maximum number of results per page.
//
// A page_size that is empty or zero lets the server choose the number of
// items to return. A page_size which is strictly positive will return at most
// that many items. A negative page_size will cause an error.
//
// Following the first request, subsequent paginated calls do not need a
// page_size field. If a page_size is set in subsequent calls, it must match
// the page_size given in the first request.
int32 page_size = 4;
// The value of `next_page_token` returned by a previous call.
string page_token = 5;
}
// Response message for BigtableInstanceAdmin.ListHotTablets.
message ListHotTabletsResponse {
// List of hot tablets in the tables of the requested cluster that fall
// within the requested time range. Hot tablets are ordered by node cpu usage
// percent. If there are multiple hot tablets that correspond to the same
// tablet within a 15-minute interval, only the hot tablet with the highest
// node cpu usage will be included in the response.
repeated HotTablet hot_tablets = 1;
// Set if not all hot tablets could be returned in a single response.
// Pass this value to `page_token` in another request to get the next
// page of results.
string next_page_token = 2;
}