aboutsummaryrefslogtreecommitdiff
path: root/google/bigtable/admin/cluster/v1/bigtable_cluster_service_messages.proto
blob: 48ea157f91248a1790a22294619f538e1037d67e (plain)
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
// Copyright 2017 Google Inc.
//
// 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.cluster.v1;

import "google/bigtable/admin/cluster/v1/bigtable_cluster_data.proto";
import "google/protobuf/timestamp.proto";

option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/cluster/v1;cluster";
option java_multiple_files = true;
option java_outer_classname = "BigtableClusterServiceMessagesProto";
option java_package = "com.google.bigtable.admin.cluster.v1";

// Request message for BigtableClusterService.ListZones.
message ListZonesRequest {
  // The unique name of the project for which a list of supported zones is
  // requested.
  // Values are of the form projects/<project>
  string name = 1;
}

// Response message for BigtableClusterService.ListZones.
message ListZonesResponse {
  // The list of requested zones.
  repeated Zone zones = 1;
}

// Request message for BigtableClusterService.GetCluster.
message GetClusterRequest {
  // The unique name of the requested cluster.
  // Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
  string name = 1;
}

// Request message for BigtableClusterService.ListClusters.
message ListClustersRequest {
  // The unique name of the project for which a list of clusters is requested.
  // Values are of the form projects/<project>
  string name = 1;
}

// Response message for BigtableClusterService.ListClusters.
message ListClustersResponse {
  // The list of requested Clusters.
  repeated Cluster clusters = 1;

  // The zones for which clusters could not be retrieved.
  repeated Zone failed_zones = 2;
}

// Request message for BigtableClusterService.CreateCluster.
message CreateClusterRequest {
  // The unique name of the zone in which to create the cluster.
  // Values are of the form projects/<project>/zones/<zone>
  string name = 1;

  // The id to be used when referring to the new cluster within its zone,
  // e.g. just the "test-cluster" section of the full name
  // "projects/<project>/zones/<zone>/clusters/test-cluster".
  string cluster_id = 2;

  // The cluster to create.
  // The "name", "delete_time", and "current_operation" fields must be left
  // blank.
  Cluster cluster = 3;
}

// Metadata type for the operation returned by
// BigtableClusterService.CreateCluster.
message CreateClusterMetadata {
  // The request which prompted the creation of this operation.
  CreateClusterRequest original_request = 1;

  // The time at which original_request was received.
  google.protobuf.Timestamp request_time = 2;

  // The time at which this operation failed or was completed successfully.
  google.protobuf.Timestamp finish_time = 3;
}

// Metadata type for the operation returned by
// BigtableClusterService.UpdateCluster.
message UpdateClusterMetadata {
  // The request which prompted the creation of this operation.
  Cluster original_request = 1;

  // The time at which original_request was received.
  google.protobuf.Timestamp request_time = 2;

  // The time at which this operation was cancelled. If set, this operation is
  // in the process of undoing itself (which is guaranteed to succeed) and
  // cannot be cancelled again.
  google.protobuf.Timestamp cancel_time = 3;

  // The time at which this operation failed or was completed successfully.
  google.protobuf.Timestamp finish_time = 4;
}

// Request message for BigtableClusterService.DeleteCluster.
message DeleteClusterRequest {
  // The unique name of the cluster to be deleted.
  // Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
  string name = 1;
}

// Request message for BigtableClusterService.UndeleteCluster.
message UndeleteClusterRequest {
  // The unique name of the cluster to be un-deleted.
  // Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
  string name = 1;
}

// Metadata type for the operation returned by
// BigtableClusterService.UndeleteCluster.
message UndeleteClusterMetadata {
  // The time at which the original request was received.
  google.protobuf.Timestamp request_time = 1;

  // The time at which this operation failed or was completed successfully.
  google.protobuf.Timestamp finish_time = 2;
}

// Metadata type for operations initiated by the V2 BigtableAdmin service.
// More complete information for such operations is available via the V2 API.
message V2OperationMetadata {}