google-cloud-bigtable-admin-v2 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.yardopts +12 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +75 -0
- data/lib/google-cloud-bigtable-admin-v2.rb +21 -0
- data/lib/google/bigtable/admin/v2/bigtable_instance_admin_pb.rb +148 -0
- data/lib/google/bigtable/admin/v2/bigtable_instance_admin_services_pb.rb +91 -0
- data/lib/google/bigtable/admin/v2/bigtable_table_admin_pb.rb +211 -0
- data/lib/google/bigtable/admin/v2/bigtable_table_admin_services_pb.rb +155 -0
- data/lib/google/bigtable/admin/v2/common_pb.rb +33 -0
- data/lib/google/bigtable/admin/v2/instance_pb.rb +77 -0
- data/lib/google/bigtable/admin/v2/table_pb.rb +130 -0
- data/lib/google/cloud/bigtable/admin/v2.rb +38 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin.rb +54 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb +1940 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/credentials.rb +59 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/operations.rb +572 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/paths.rb +121 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin.rb +56 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/client.rb +2293 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/credentials.rb +58 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/operations.rb +572 -0
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/paths.rb +132 -0
- data/lib/google/cloud/bigtable/admin/v2/version.rb +30 -0
- data/proto_docs/README.md +4 -0
- data/proto_docs/google/api/field_behavior.rb +59 -0
- data/proto_docs/google/api/resource.rb +247 -0
- data/proto_docs/google/bigtable/admin/v2/bigtable_instance_admin.rb +378 -0
- data/proto_docs/google/bigtable/admin/v2/bigtable_table_admin.rb +686 -0
- data/proto_docs/google/bigtable/admin/v2/common.rb +58 -0
- data/proto_docs/google/bigtable/admin/v2/instance.rb +223 -0
- data/proto_docs/google/bigtable/admin/v2/table.rb +357 -0
- data/proto_docs/google/iam/v1/iam_policy.rb +80 -0
- data/proto_docs/google/iam/v1/options.rb +40 -0
- data/proto_docs/google/iam/v1/policy.rb +248 -0
- data/proto_docs/google/longrunning/operations.rb +150 -0
- data/proto_docs/google/protobuf/any.rb +138 -0
- data/proto_docs/google/protobuf/duration.rb +98 -0
- data/proto_docs/google/protobuf/empty.rb +36 -0
- data/proto_docs/google/protobuf/field_mask.rb +229 -0
- data/proto_docs/google/protobuf/timestamp.rb +120 -0
- data/proto_docs/google/rpc/status.rb +46 -0
- data/proto_docs/google/type/expr.rb +52 -0
- metadata +246 -0
@@ -0,0 +1,378 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Bigtable
|
23
|
+
module Admin
|
24
|
+
module V2
|
25
|
+
# Request message for BigtableInstanceAdmin.CreateInstance.
|
26
|
+
# @!attribute [rw] parent
|
27
|
+
# @return [::String]
|
28
|
+
# Required. The unique name of the project in which to create the new instance.
|
29
|
+
# Values are of the form `projects/{project}`.
|
30
|
+
# @!attribute [rw] instance_id
|
31
|
+
# @return [::String]
|
32
|
+
# Required. The ID to be used when referring to the new instance within its project,
|
33
|
+
# e.g., just `myinstance` rather than
|
34
|
+
# `projects/myproject/instances/myinstance`.
|
35
|
+
# @!attribute [rw] instance
|
36
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Instance]
|
37
|
+
# Required. The instance to create.
|
38
|
+
# Fields marked `OutputOnly` must be left blank.
|
39
|
+
# @!attribute [rw] clusters
|
40
|
+
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Bigtable::Admin::V2::Cluster}]
|
41
|
+
# Required. The clusters to be created within the instance, mapped by desired
|
42
|
+
# cluster ID, e.g., just `mycluster` rather than
|
43
|
+
# `projects/myproject/instances/myinstance/clusters/mycluster`.
|
44
|
+
# Fields marked `OutputOnly` must be left blank.
|
45
|
+
# Currently, at most four clusters can be specified.
|
46
|
+
class CreateInstanceRequest
|
47
|
+
include ::Google::Protobuf::MessageExts
|
48
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
49
|
+
|
50
|
+
# @!attribute [rw] key
|
51
|
+
# @return [::String]
|
52
|
+
# @!attribute [rw] value
|
53
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Cluster]
|
54
|
+
class ClustersEntry
|
55
|
+
include ::Google::Protobuf::MessageExts
|
56
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# Request message for BigtableInstanceAdmin.GetInstance.
|
61
|
+
# @!attribute [rw] name
|
62
|
+
# @return [::String]
|
63
|
+
# Required. The unique name of the requested instance. Values are of the form
|
64
|
+
# `projects/{project}/instances/{instance}`.
|
65
|
+
class GetInstanceRequest
|
66
|
+
include ::Google::Protobuf::MessageExts
|
67
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
68
|
+
end
|
69
|
+
|
70
|
+
# Request message for BigtableInstanceAdmin.ListInstances.
|
71
|
+
# @!attribute [rw] parent
|
72
|
+
# @return [::String]
|
73
|
+
# Required. The unique name of the project for which a list of instances is requested.
|
74
|
+
# Values are of the form `projects/{project}`.
|
75
|
+
# @!attribute [rw] page_token
|
76
|
+
# @return [::String]
|
77
|
+
# DEPRECATED: This field is unused and ignored.
|
78
|
+
class ListInstancesRequest
|
79
|
+
include ::Google::Protobuf::MessageExts
|
80
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
81
|
+
end
|
82
|
+
|
83
|
+
# Response message for BigtableInstanceAdmin.ListInstances.
|
84
|
+
# @!attribute [rw] instances
|
85
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::Instance>]
|
86
|
+
# The list of requested instances.
|
87
|
+
# @!attribute [rw] failed_locations
|
88
|
+
# @return [::Array<::String>]
|
89
|
+
# Locations from which Instance information could not be retrieved,
|
90
|
+
# due to an outage or some other transient condition.
|
91
|
+
# Instances whose Clusters are all in one of the failed locations
|
92
|
+
# may be missing from `instances`, and Instances with at least one
|
93
|
+
# Cluster in a failed location may only have partial information returned.
|
94
|
+
# Values are of the form `projects/<project>/locations/<zone_id>`
|
95
|
+
# @!attribute [rw] next_page_token
|
96
|
+
# @return [::String]
|
97
|
+
# DEPRECATED: This field is unused and ignored.
|
98
|
+
class ListInstancesResponse
|
99
|
+
include ::Google::Protobuf::MessageExts
|
100
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
101
|
+
end
|
102
|
+
|
103
|
+
# Request message for BigtableInstanceAdmin.PartialUpdateInstance.
|
104
|
+
# @!attribute [rw] instance
|
105
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Instance]
|
106
|
+
# Required. The Instance which will (partially) replace the current value.
|
107
|
+
# @!attribute [rw] update_mask
|
108
|
+
# @return [::Google::Protobuf::FieldMask]
|
109
|
+
# Required. The subset of Instance fields which should be replaced.
|
110
|
+
# Must be explicitly set.
|
111
|
+
class PartialUpdateInstanceRequest
|
112
|
+
include ::Google::Protobuf::MessageExts
|
113
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
114
|
+
end
|
115
|
+
|
116
|
+
# Request message for BigtableInstanceAdmin.DeleteInstance.
|
117
|
+
# @!attribute [rw] name
|
118
|
+
# @return [::String]
|
119
|
+
# Required. The unique name of the instance to be deleted.
|
120
|
+
# Values are of the form `projects/{project}/instances/{instance}`.
|
121
|
+
class DeleteInstanceRequest
|
122
|
+
include ::Google::Protobuf::MessageExts
|
123
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
124
|
+
end
|
125
|
+
|
126
|
+
# Request message for BigtableInstanceAdmin.CreateCluster.
|
127
|
+
# @!attribute [rw] parent
|
128
|
+
# @return [::String]
|
129
|
+
# Required. The unique name of the instance in which to create the new cluster.
|
130
|
+
# Values are of the form
|
131
|
+
# `projects/{project}/instances/{instance}`.
|
132
|
+
# @!attribute [rw] cluster_id
|
133
|
+
# @return [::String]
|
134
|
+
# Required. The ID to be used when referring to the new cluster within its instance,
|
135
|
+
# e.g., just `mycluster` rather than
|
136
|
+
# `projects/myproject/instances/myinstance/clusters/mycluster`.
|
137
|
+
# @!attribute [rw] cluster
|
138
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Cluster]
|
139
|
+
# Required. The cluster to be created.
|
140
|
+
# Fields marked `OutputOnly` must be left blank.
|
141
|
+
class CreateClusterRequest
|
142
|
+
include ::Google::Protobuf::MessageExts
|
143
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
144
|
+
end
|
145
|
+
|
146
|
+
# Request message for BigtableInstanceAdmin.GetCluster.
|
147
|
+
# @!attribute [rw] name
|
148
|
+
# @return [::String]
|
149
|
+
# Required. The unique name of the requested cluster. Values are of the form
|
150
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
151
|
+
class GetClusterRequest
|
152
|
+
include ::Google::Protobuf::MessageExts
|
153
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
154
|
+
end
|
155
|
+
|
156
|
+
# Request message for BigtableInstanceAdmin.ListClusters.
|
157
|
+
# @!attribute [rw] parent
|
158
|
+
# @return [::String]
|
159
|
+
# Required. The unique name of the instance for which a list of clusters is requested.
|
160
|
+
# Values are of the form `projects/{project}/instances/{instance}`.
|
161
|
+
# Use `{instance} = '-'` to list Clusters for all Instances in a project,
|
162
|
+
# e.g., `projects/myproject/instances/-`.
|
163
|
+
# @!attribute [rw] page_token
|
164
|
+
# @return [::String]
|
165
|
+
# DEPRECATED: This field is unused and ignored.
|
166
|
+
class ListClustersRequest
|
167
|
+
include ::Google::Protobuf::MessageExts
|
168
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
169
|
+
end
|
170
|
+
|
171
|
+
# Response message for BigtableInstanceAdmin.ListClusters.
|
172
|
+
# @!attribute [rw] clusters
|
173
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::Cluster>]
|
174
|
+
# The list of requested clusters.
|
175
|
+
# @!attribute [rw] failed_locations
|
176
|
+
# @return [::Array<::String>]
|
177
|
+
# Locations from which Cluster information could not be retrieved,
|
178
|
+
# due to an outage or some other transient condition.
|
179
|
+
# Clusters from these locations may be missing from `clusters`,
|
180
|
+
# or may only have partial information returned.
|
181
|
+
# Values are of the form `projects/<project>/locations/<zone_id>`
|
182
|
+
# @!attribute [rw] next_page_token
|
183
|
+
# @return [::String]
|
184
|
+
# DEPRECATED: This field is unused and ignored.
|
185
|
+
class ListClustersResponse
|
186
|
+
include ::Google::Protobuf::MessageExts
|
187
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
188
|
+
end
|
189
|
+
|
190
|
+
# Request message for BigtableInstanceAdmin.DeleteCluster.
|
191
|
+
# @!attribute [rw] name
|
192
|
+
# @return [::String]
|
193
|
+
# Required. The unique name of the cluster to be deleted. Values are of the form
|
194
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
195
|
+
class DeleteClusterRequest
|
196
|
+
include ::Google::Protobuf::MessageExts
|
197
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
198
|
+
end
|
199
|
+
|
200
|
+
# The metadata for the Operation returned by CreateInstance.
|
201
|
+
# @!attribute [rw] original_request
|
202
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::CreateInstanceRequest]
|
203
|
+
# The request that prompted the initiation of this CreateInstance operation.
|
204
|
+
# @!attribute [rw] request_time
|
205
|
+
# @return [::Google::Protobuf::Timestamp]
|
206
|
+
# The time at which the original request was received.
|
207
|
+
# @!attribute [rw] finish_time
|
208
|
+
# @return [::Google::Protobuf::Timestamp]
|
209
|
+
# The time at which the operation failed or was completed successfully.
|
210
|
+
class CreateInstanceMetadata
|
211
|
+
include ::Google::Protobuf::MessageExts
|
212
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
213
|
+
end
|
214
|
+
|
215
|
+
# The metadata for the Operation returned by UpdateInstance.
|
216
|
+
# @!attribute [rw] original_request
|
217
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::PartialUpdateInstanceRequest]
|
218
|
+
# The request that prompted the initiation of this UpdateInstance operation.
|
219
|
+
# @!attribute [rw] request_time
|
220
|
+
# @return [::Google::Protobuf::Timestamp]
|
221
|
+
# The time at which the original request was received.
|
222
|
+
# @!attribute [rw] finish_time
|
223
|
+
# @return [::Google::Protobuf::Timestamp]
|
224
|
+
# The time at which the operation failed or was completed successfully.
|
225
|
+
class UpdateInstanceMetadata
|
226
|
+
include ::Google::Protobuf::MessageExts
|
227
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
228
|
+
end
|
229
|
+
|
230
|
+
# The metadata for the Operation returned by CreateCluster.
|
231
|
+
# @!attribute [rw] original_request
|
232
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::CreateClusterRequest]
|
233
|
+
# The request that prompted the initiation of this CreateCluster operation.
|
234
|
+
# @!attribute [rw] request_time
|
235
|
+
# @return [::Google::Protobuf::Timestamp]
|
236
|
+
# The time at which the original request was received.
|
237
|
+
# @!attribute [rw] finish_time
|
238
|
+
# @return [::Google::Protobuf::Timestamp]
|
239
|
+
# The time at which the operation failed or was completed successfully.
|
240
|
+
class CreateClusterMetadata
|
241
|
+
include ::Google::Protobuf::MessageExts
|
242
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
243
|
+
end
|
244
|
+
|
245
|
+
# The metadata for the Operation returned by UpdateCluster.
|
246
|
+
# @!attribute [rw] original_request
|
247
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Cluster]
|
248
|
+
# The request that prompted the initiation of this UpdateCluster operation.
|
249
|
+
# @!attribute [rw] request_time
|
250
|
+
# @return [::Google::Protobuf::Timestamp]
|
251
|
+
# The time at which the original request was received.
|
252
|
+
# @!attribute [rw] finish_time
|
253
|
+
# @return [::Google::Protobuf::Timestamp]
|
254
|
+
# The time at which the operation failed or was completed successfully.
|
255
|
+
class UpdateClusterMetadata
|
256
|
+
include ::Google::Protobuf::MessageExts
|
257
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
258
|
+
end
|
259
|
+
|
260
|
+
# Request message for BigtableInstanceAdmin.CreateAppProfile.
|
261
|
+
# @!attribute [rw] parent
|
262
|
+
# @return [::String]
|
263
|
+
# Required. The unique name of the instance in which to create the new app profile.
|
264
|
+
# Values are of the form
|
265
|
+
# `projects/{project}/instances/{instance}`.
|
266
|
+
# @!attribute [rw] app_profile_id
|
267
|
+
# @return [::String]
|
268
|
+
# Required. The ID to be used when referring to the new app profile within its
|
269
|
+
# instance, e.g., just `myprofile` rather than
|
270
|
+
# `projects/myproject/instances/myinstance/appProfiles/myprofile`.
|
271
|
+
# @!attribute [rw] app_profile
|
272
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile]
|
273
|
+
# Required. The app profile to be created.
|
274
|
+
# Fields marked `OutputOnly` will be ignored.
|
275
|
+
# @!attribute [rw] ignore_warnings
|
276
|
+
# @return [::Boolean]
|
277
|
+
# If true, ignore safety checks when creating the app profile.
|
278
|
+
class CreateAppProfileRequest
|
279
|
+
include ::Google::Protobuf::MessageExts
|
280
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
281
|
+
end
|
282
|
+
|
283
|
+
# Request message for BigtableInstanceAdmin.GetAppProfile.
|
284
|
+
# @!attribute [rw] name
|
285
|
+
# @return [::String]
|
286
|
+
# Required. The unique name of the requested app profile. Values are of the form
|
287
|
+
# `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
|
288
|
+
class GetAppProfileRequest
|
289
|
+
include ::Google::Protobuf::MessageExts
|
290
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
291
|
+
end
|
292
|
+
|
293
|
+
# Request message for BigtableInstanceAdmin.ListAppProfiles.
|
294
|
+
# @!attribute [rw] parent
|
295
|
+
# @return [::String]
|
296
|
+
# Required. The unique name of the instance for which a list of app profiles is
|
297
|
+
# requested. Values are of the form
|
298
|
+
# `projects/{project}/instances/{instance}`.
|
299
|
+
# Use `{instance} = '-'` to list AppProfiles for all Instances in a project,
|
300
|
+
# e.g., `projects/myproject/instances/-`.
|
301
|
+
# @!attribute [rw] page_size
|
302
|
+
# @return [::Integer]
|
303
|
+
# Maximum number of results per page.
|
304
|
+
#
|
305
|
+
# A page_size of zero lets the server choose the number of items to return.
|
306
|
+
# A page_size which is strictly positive will return at most that many items.
|
307
|
+
# A negative page_size will cause an error.
|
308
|
+
#
|
309
|
+
# Following the first request, subsequent paginated calls are not required
|
310
|
+
# to pass a page_size. If a page_size is set in subsequent calls, it must
|
311
|
+
# match the page_size given in the first request.
|
312
|
+
# @!attribute [rw] page_token
|
313
|
+
# @return [::String]
|
314
|
+
# The value of `next_page_token` returned by a previous call.
|
315
|
+
class ListAppProfilesRequest
|
316
|
+
include ::Google::Protobuf::MessageExts
|
317
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
318
|
+
end
|
319
|
+
|
320
|
+
# Response message for BigtableInstanceAdmin.ListAppProfiles.
|
321
|
+
# @!attribute [rw] app_profiles
|
322
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::AppProfile>]
|
323
|
+
# The list of requested app profiles.
|
324
|
+
# @!attribute [rw] next_page_token
|
325
|
+
# @return [::String]
|
326
|
+
# Set if not all app profiles could be returned in a single response.
|
327
|
+
# Pass this value to `page_token` in another request to get the next
|
328
|
+
# page of results.
|
329
|
+
# @!attribute [rw] failed_locations
|
330
|
+
# @return [::Array<::String>]
|
331
|
+
# Locations from which AppProfile information could not be retrieved,
|
332
|
+
# due to an outage or some other transient condition.
|
333
|
+
# AppProfiles from these locations may be missing from `app_profiles`.
|
334
|
+
# Values are of the form `projects/<project>/locations/<zone_id>`
|
335
|
+
class ListAppProfilesResponse
|
336
|
+
include ::Google::Protobuf::MessageExts
|
337
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
338
|
+
end
|
339
|
+
|
340
|
+
# Request message for BigtableInstanceAdmin.UpdateAppProfile.
|
341
|
+
# @!attribute [rw] app_profile
|
342
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile]
|
343
|
+
# Required. The app profile which will (partially) replace the current value.
|
344
|
+
# @!attribute [rw] update_mask
|
345
|
+
# @return [::Google::Protobuf::FieldMask]
|
346
|
+
# Required. The subset of app profile fields which should be replaced.
|
347
|
+
# If unset, all fields will be replaced.
|
348
|
+
# @!attribute [rw] ignore_warnings
|
349
|
+
# @return [::Boolean]
|
350
|
+
# If true, ignore safety checks when updating the app profile.
|
351
|
+
class UpdateAppProfileRequest
|
352
|
+
include ::Google::Protobuf::MessageExts
|
353
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
354
|
+
end
|
355
|
+
|
356
|
+
# Request message for BigtableInstanceAdmin.DeleteAppProfile.
|
357
|
+
# @!attribute [rw] name
|
358
|
+
# @return [::String]
|
359
|
+
# Required. The unique name of the app profile to be deleted. Values are of the form
|
360
|
+
# `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
|
361
|
+
# @!attribute [rw] ignore_warnings
|
362
|
+
# @return [::Boolean]
|
363
|
+
# If true, ignore safety checks when deleting the app profile.
|
364
|
+
class DeleteAppProfileRequest
|
365
|
+
include ::Google::Protobuf::MessageExts
|
366
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
367
|
+
end
|
368
|
+
|
369
|
+
# The metadata for the Operation returned by UpdateAppProfile.
|
370
|
+
class UpdateAppProfileMetadata
|
371
|
+
include ::Google::Protobuf::MessageExts
|
372
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
373
|
+
end
|
374
|
+
end
|
375
|
+
end
|
376
|
+
end
|
377
|
+
end
|
378
|
+
end
|
@@ -0,0 +1,686 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Bigtable
|
23
|
+
module Admin
|
24
|
+
module V2
|
25
|
+
# Request message for
|
26
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#create_table google.bigtable.admin.v2.BigtableTableAdmin.CreateTable}
|
27
|
+
# @!attribute [rw] parent
|
28
|
+
# @return [::String]
|
29
|
+
# Required. The unique name of the instance in which to create the table.
|
30
|
+
# Values are of the form `projects/{project}/instances/{instance}`.
|
31
|
+
# @!attribute [rw] table_id
|
32
|
+
# @return [::String]
|
33
|
+
# Required. The name by which the new table should be referred to within the
|
34
|
+
# parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
|
35
|
+
# Maximum 50 characters.
|
36
|
+
# @!attribute [rw] table
|
37
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Table]
|
38
|
+
# Required. The Table to create.
|
39
|
+
# @!attribute [rw] initial_splits
|
40
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::CreateTableRequest::Split>]
|
41
|
+
# The optional list of row keys that will be used to initially split the
|
42
|
+
# table into several tablets (tablets are similar to HBase regions).
|
43
|
+
# Given two split keys, `s1` and `s2`, three tablets will be created,
|
44
|
+
# spanning the key ranges: `[, s1), [s1, s2), [s2, )`.
|
45
|
+
#
|
46
|
+
# Example:
|
47
|
+
#
|
48
|
+
# * Row keys := `["a", "apple", "custom", "customer_1", "customer_2",`
|
49
|
+
# `"other", "zz"]`
|
50
|
+
# * initial_split_keys := `["apple", "customer_1", "customer_2", "other"]`
|
51
|
+
# * Key assignment:
|
52
|
+
# - Tablet 1 `[, apple) => {"a"}.`
|
53
|
+
# - Tablet 2 `[apple, customer_1) => {"apple", "custom"}.`
|
54
|
+
# - Tablet 3 `[customer_1, customer_2) => {"customer_1"}.`
|
55
|
+
# - Tablet 4 `[customer_2, other) => {"customer_2"}.`
|
56
|
+
# - Tablet 5 `[other, ) => {"other", "zz"}.`
|
57
|
+
class CreateTableRequest
|
58
|
+
include ::Google::Protobuf::MessageExts
|
59
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
60
|
+
|
61
|
+
# An initial split point for a newly created table.
|
62
|
+
# @!attribute [rw] key
|
63
|
+
# @return [::String]
|
64
|
+
# Row key to use as an initial tablet boundary.
|
65
|
+
class Split
|
66
|
+
include ::Google::Protobuf::MessageExts
|
67
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
# Request message for
|
72
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#create_table_from_snapshot google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot}
|
73
|
+
#
|
74
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
75
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
76
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
77
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
78
|
+
# @!attribute [rw] parent
|
79
|
+
# @return [::String]
|
80
|
+
# Required. The unique name of the instance in which to create the table.
|
81
|
+
# Values are of the form `projects/{project}/instances/{instance}`.
|
82
|
+
# @!attribute [rw] table_id
|
83
|
+
# @return [::String]
|
84
|
+
# Required. The name by which the new table should be referred to within the
|
85
|
+
# parent instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
|
86
|
+
# @!attribute [rw] source_snapshot
|
87
|
+
# @return [::String]
|
88
|
+
# Required. The unique name of the snapshot from which to restore the table.
|
89
|
+
# The snapshot and the table must be in the same instance. Values are of the
|
90
|
+
# form
|
91
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
|
92
|
+
class CreateTableFromSnapshotRequest
|
93
|
+
include ::Google::Protobuf::MessageExts
|
94
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
|
+
end
|
96
|
+
|
97
|
+
# Request message for
|
98
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#drop_row_range google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange}
|
99
|
+
# @!attribute [rw] name
|
100
|
+
# @return [::String]
|
101
|
+
# Required. The unique name of the table on which to drop a range of rows.
|
102
|
+
# Values are of the form
|
103
|
+
# `projects/{project}/instances/{instance}/tables/{table}`.
|
104
|
+
# @!attribute [rw] row_key_prefix
|
105
|
+
# @return [::String]
|
106
|
+
# Delete all rows that start with this row key prefix. Prefix cannot be
|
107
|
+
# zero length.
|
108
|
+
# @!attribute [rw] delete_all_data_from_table
|
109
|
+
# @return [::Boolean]
|
110
|
+
# Delete all rows in the table. Setting this to false is a no-op.
|
111
|
+
class DropRowRangeRequest
|
112
|
+
include ::Google::Protobuf::MessageExts
|
113
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
114
|
+
end
|
115
|
+
|
116
|
+
# Request message for
|
117
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_tables google.bigtable.admin.v2.BigtableTableAdmin.ListTables}
|
118
|
+
# @!attribute [rw] parent
|
119
|
+
# @return [::String]
|
120
|
+
# Required. The unique name of the instance for which tables should be
|
121
|
+
# listed. Values are of the form `projects/{project}/instances/{instance}`.
|
122
|
+
# @!attribute [rw] view
|
123
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Table::View]
|
124
|
+
# The view to be applied to the returned tables' fields.
|
125
|
+
# Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.
|
126
|
+
# @!attribute [rw] page_size
|
127
|
+
# @return [::Integer]
|
128
|
+
# Maximum number of results per page.
|
129
|
+
#
|
130
|
+
# A page_size of zero lets the server choose the number of items to return.
|
131
|
+
# A page_size which is strictly positive will return at most that many items.
|
132
|
+
# A negative page_size will cause an error.
|
133
|
+
#
|
134
|
+
# Following the first request, subsequent paginated calls are not required
|
135
|
+
# to pass a page_size. If a page_size is set in subsequent calls, it must
|
136
|
+
# match the page_size given in the first request.
|
137
|
+
# @!attribute [rw] page_token
|
138
|
+
# @return [::String]
|
139
|
+
# The value of `next_page_token` returned by a previous call.
|
140
|
+
class ListTablesRequest
|
141
|
+
include ::Google::Protobuf::MessageExts
|
142
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
143
|
+
end
|
144
|
+
|
145
|
+
# Response message for
|
146
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_tables google.bigtable.admin.v2.BigtableTableAdmin.ListTables}
|
147
|
+
# @!attribute [rw] tables
|
148
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::Table>]
|
149
|
+
# The tables present in the requested instance.
|
150
|
+
# @!attribute [rw] next_page_token
|
151
|
+
# @return [::String]
|
152
|
+
# Set if not all tables could be returned in a single response.
|
153
|
+
# Pass this value to `page_token` in another request to get the next
|
154
|
+
# page of results.
|
155
|
+
class ListTablesResponse
|
156
|
+
include ::Google::Protobuf::MessageExts
|
157
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
158
|
+
end
|
159
|
+
|
160
|
+
# Request message for
|
161
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#get_table google.bigtable.admin.v2.BigtableTableAdmin.GetTable}
|
162
|
+
# @!attribute [rw] name
|
163
|
+
# @return [::String]
|
164
|
+
# Required. The unique name of the requested table.
|
165
|
+
# Values are of the form
|
166
|
+
# `projects/{project}/instances/{instance}/tables/{table}`.
|
167
|
+
# @!attribute [rw] view
|
168
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Table::View]
|
169
|
+
# The view to be applied to the returned table's fields.
|
170
|
+
# Defaults to `SCHEMA_VIEW` if unspecified.
|
171
|
+
class GetTableRequest
|
172
|
+
include ::Google::Protobuf::MessageExts
|
173
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
174
|
+
end
|
175
|
+
|
176
|
+
# Request message for
|
177
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#delete_table google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable}
|
178
|
+
# @!attribute [rw] name
|
179
|
+
# @return [::String]
|
180
|
+
# Required. The unique name of the table to be deleted.
|
181
|
+
# Values are of the form
|
182
|
+
# `projects/{project}/instances/{instance}/tables/{table}`.
|
183
|
+
class DeleteTableRequest
|
184
|
+
include ::Google::Protobuf::MessageExts
|
185
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
186
|
+
end
|
187
|
+
|
188
|
+
# Request message for
|
189
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#modify_column_families google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies}
|
190
|
+
# @!attribute [rw] name
|
191
|
+
# @return [::String]
|
192
|
+
# Required. The unique name of the table whose families should be modified.
|
193
|
+
# Values are of the form
|
194
|
+
# `projects/{project}/instances/{instance}/tables/{table}`.
|
195
|
+
# @!attribute [rw] modifications
|
196
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
|
197
|
+
# Required. Modifications to be atomically applied to the specified table's
|
198
|
+
# families. Entries are applied in order, meaning that earlier modifications
|
199
|
+
# can be masked by later ones (in the case of repeated updates to the same
|
200
|
+
# family, for example).
|
201
|
+
class ModifyColumnFamiliesRequest
|
202
|
+
include ::Google::Protobuf::MessageExts
|
203
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
204
|
+
|
205
|
+
# A create, update, or delete of a particular column family.
|
206
|
+
# @!attribute [rw] id
|
207
|
+
# @return [::String]
|
208
|
+
# The ID of the column family to be modified.
|
209
|
+
# @!attribute [rw] create
|
210
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::ColumnFamily]
|
211
|
+
# Create a new column family with the specified schema, or fail if
|
212
|
+
# one already exists with the given ID.
|
213
|
+
# @!attribute [rw] update
|
214
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::ColumnFamily]
|
215
|
+
# Update an existing column family to the specified schema, or fail
|
216
|
+
# if no column family exists with the given ID.
|
217
|
+
# @!attribute [rw] drop
|
218
|
+
# @return [::Boolean]
|
219
|
+
# Drop (delete) the column family with the given ID, or fail if no such
|
220
|
+
# family exists.
|
221
|
+
class Modification
|
222
|
+
include ::Google::Protobuf::MessageExts
|
223
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
224
|
+
end
|
225
|
+
end
|
226
|
+
|
227
|
+
# Request message for
|
228
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#generate_consistency_token google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken}
|
229
|
+
# @!attribute [rw] name
|
230
|
+
# @return [::String]
|
231
|
+
# Required. The unique name of the Table for which to create a consistency
|
232
|
+
# token. Values are of the form
|
233
|
+
# `projects/{project}/instances/{instance}/tables/{table}`.
|
234
|
+
class GenerateConsistencyTokenRequest
|
235
|
+
include ::Google::Protobuf::MessageExts
|
236
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
237
|
+
end
|
238
|
+
|
239
|
+
# Response message for
|
240
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#generate_consistency_token google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken}
|
241
|
+
# @!attribute [rw] consistency_token
|
242
|
+
# @return [::String]
|
243
|
+
# The generated consistency token.
|
244
|
+
class GenerateConsistencyTokenResponse
|
245
|
+
include ::Google::Protobuf::MessageExts
|
246
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
247
|
+
end
|
248
|
+
|
249
|
+
# Request message for
|
250
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#check_consistency google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency}
|
251
|
+
# @!attribute [rw] name
|
252
|
+
# @return [::String]
|
253
|
+
# Required. The unique name of the Table for which to check replication
|
254
|
+
# consistency. Values are of the form
|
255
|
+
# `projects/{project}/instances/{instance}/tables/{table}`.
|
256
|
+
# @!attribute [rw] consistency_token
|
257
|
+
# @return [::String]
|
258
|
+
# Required. The token created using GenerateConsistencyToken for the Table.
|
259
|
+
class CheckConsistencyRequest
|
260
|
+
include ::Google::Protobuf::MessageExts
|
261
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
262
|
+
end
|
263
|
+
|
264
|
+
# Response message for
|
265
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#check_consistency google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency}
|
266
|
+
# @!attribute [rw] consistent
|
267
|
+
# @return [::Boolean]
|
268
|
+
# True only if the token is consistent. A token is consistent if replication
|
269
|
+
# has caught up with the restrictions specified in the request.
|
270
|
+
class CheckConsistencyResponse
|
271
|
+
include ::Google::Protobuf::MessageExts
|
272
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
273
|
+
end
|
274
|
+
|
275
|
+
# Request message for
|
276
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#snapshot_table google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable}
|
277
|
+
#
|
278
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
279
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
280
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
281
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
282
|
+
# @!attribute [rw] name
|
283
|
+
# @return [::String]
|
284
|
+
# Required. The unique name of the table to have the snapshot taken.
|
285
|
+
# Values are of the form
|
286
|
+
# `projects/{project}/instances/{instance}/tables/{table}`.
|
287
|
+
# @!attribute [rw] cluster
|
288
|
+
# @return [::String]
|
289
|
+
# Required. The name of the cluster where the snapshot will be created in.
|
290
|
+
# Values are of the form
|
291
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
292
|
+
# @!attribute [rw] snapshot_id
|
293
|
+
# @return [::String]
|
294
|
+
# Required. The ID by which the new snapshot should be referred to within the
|
295
|
+
# parent cluster, e.g., `mysnapshot` of the form:
|
296
|
+
# `[_a-zA-Z0-9][-_.a-zA-Z0-9]*` rather than
|
297
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
|
298
|
+
# @!attribute [rw] ttl
|
299
|
+
# @return [::Google::Protobuf::Duration]
|
300
|
+
# The amount of time that the new snapshot can stay active after it is
|
301
|
+
# created. Once 'ttl' expires, the snapshot will get deleted. The maximum
|
302
|
+
# amount of time a snapshot can stay active is 7 days. If 'ttl' is not
|
303
|
+
# specified, the default value of 24 hours will be used.
|
304
|
+
# @!attribute [rw] description
|
305
|
+
# @return [::String]
|
306
|
+
# Description of the snapshot.
|
307
|
+
class SnapshotTableRequest
|
308
|
+
include ::Google::Protobuf::MessageExts
|
309
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
310
|
+
end
|
311
|
+
|
312
|
+
# Request message for
|
313
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#get_snapshot google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot}
|
314
|
+
#
|
315
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
316
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
317
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
318
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
319
|
+
# @!attribute [rw] name
|
320
|
+
# @return [::String]
|
321
|
+
# Required. The unique name of the requested snapshot.
|
322
|
+
# Values are of the form
|
323
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
|
324
|
+
class GetSnapshotRequest
|
325
|
+
include ::Google::Protobuf::MessageExts
|
326
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
327
|
+
end
|
328
|
+
|
329
|
+
# Request message for
|
330
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_snapshots google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots}
|
331
|
+
#
|
332
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
333
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
334
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
335
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
336
|
+
# @!attribute [rw] parent
|
337
|
+
# @return [::String]
|
338
|
+
# Required. The unique name of the cluster for which snapshots should be
|
339
|
+
# listed. Values are of the form
|
340
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
341
|
+
# Use `{cluster} = '-'` to list snapshots for all clusters in an instance,
|
342
|
+
# e.g., `projects/{project}/instances/{instance}/clusters/-`.
|
343
|
+
# @!attribute [rw] page_size
|
344
|
+
# @return [::Integer]
|
345
|
+
# The maximum number of snapshots to return per page.
|
346
|
+
# CURRENTLY UNIMPLEMENTED AND IGNORED.
|
347
|
+
# @!attribute [rw] page_token
|
348
|
+
# @return [::String]
|
349
|
+
# The value of `next_page_token` returned by a previous call.
|
350
|
+
class ListSnapshotsRequest
|
351
|
+
include ::Google::Protobuf::MessageExts
|
352
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
353
|
+
end
|
354
|
+
|
355
|
+
# Response message for
|
356
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_snapshots google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots}
|
357
|
+
#
|
358
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
359
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
360
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
361
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
362
|
+
# @!attribute [rw] snapshots
|
363
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::Snapshot>]
|
364
|
+
# The snapshots present in the requested cluster.
|
365
|
+
# @!attribute [rw] next_page_token
|
366
|
+
# @return [::String]
|
367
|
+
# Set if not all snapshots could be returned in a single response.
|
368
|
+
# Pass this value to `page_token` in another request to get the next
|
369
|
+
# page of results.
|
370
|
+
class ListSnapshotsResponse
|
371
|
+
include ::Google::Protobuf::MessageExts
|
372
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
373
|
+
end
|
374
|
+
|
375
|
+
# Request message for
|
376
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#delete_snapshot google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot}
|
377
|
+
#
|
378
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
379
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
380
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
381
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
382
|
+
# @!attribute [rw] name
|
383
|
+
# @return [::String]
|
384
|
+
# Required. The unique name of the snapshot to be deleted.
|
385
|
+
# Values are of the form
|
386
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
|
387
|
+
class DeleteSnapshotRequest
|
388
|
+
include ::Google::Protobuf::MessageExts
|
389
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
390
|
+
end
|
391
|
+
|
392
|
+
# The metadata for the Operation returned by SnapshotTable.
|
393
|
+
#
|
394
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
395
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
396
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
397
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
398
|
+
# @!attribute [rw] original_request
|
399
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::SnapshotTableRequest]
|
400
|
+
# The request that prompted the initiation of this SnapshotTable operation.
|
401
|
+
# @!attribute [rw] request_time
|
402
|
+
# @return [::Google::Protobuf::Timestamp]
|
403
|
+
# The time at which the original request was received.
|
404
|
+
# @!attribute [rw] finish_time
|
405
|
+
# @return [::Google::Protobuf::Timestamp]
|
406
|
+
# The time at which the operation failed or was completed successfully.
|
407
|
+
class SnapshotTableMetadata
|
408
|
+
include ::Google::Protobuf::MessageExts
|
409
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
410
|
+
end
|
411
|
+
|
412
|
+
# The metadata for the Operation returned by CreateTableFromSnapshot.
|
413
|
+
#
|
414
|
+
# Note: This is a private alpha release of Cloud Bigtable snapshots. This
|
415
|
+
# feature is not currently available to most Cloud Bigtable customers. This
|
416
|
+
# feature might be changed in backward-incompatible ways and is not recommended
|
417
|
+
# for production use. It is not subject to any SLA or deprecation policy.
|
418
|
+
# @!attribute [rw] original_request
|
419
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::CreateTableFromSnapshotRequest]
|
420
|
+
# The request that prompted the initiation of this CreateTableFromSnapshot
|
421
|
+
# operation.
|
422
|
+
# @!attribute [rw] request_time
|
423
|
+
# @return [::Google::Protobuf::Timestamp]
|
424
|
+
# The time at which the original request was received.
|
425
|
+
# @!attribute [rw] finish_time
|
426
|
+
# @return [::Google::Protobuf::Timestamp]
|
427
|
+
# The time at which the operation failed or was completed successfully.
|
428
|
+
class CreateTableFromSnapshotMetadata
|
429
|
+
include ::Google::Protobuf::MessageExts
|
430
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
431
|
+
end
|
432
|
+
|
433
|
+
# The request for
|
434
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#create_backup CreateBackup}.
|
435
|
+
# @!attribute [rw] parent
|
436
|
+
# @return [::String]
|
437
|
+
# Required. This must be one of the clusters in the instance in which this
|
438
|
+
# table is located. The backup will be stored in this cluster. Values are
|
439
|
+
# of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
440
|
+
# @!attribute [rw] backup_id
|
441
|
+
# @return [::String]
|
442
|
+
# Required. The id of the backup to be created. The `backup_id` along with
|
443
|
+
# the parent `parent` are combined as \\{parent}/backups/\\{backup_id} to create
|
444
|
+
# the full backup name, of the form:
|
445
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}`.
|
446
|
+
# This string must be between 1 and 50 characters in length and match the
|
447
|
+
# regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
|
448
|
+
# @!attribute [rw] backup
|
449
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Backup]
|
450
|
+
# Required. The backup to create.
|
451
|
+
class CreateBackupRequest
|
452
|
+
include ::Google::Protobuf::MessageExts
|
453
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
454
|
+
end
|
455
|
+
|
456
|
+
# Metadata type for the operation returned by
|
457
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#create_backup CreateBackup}.
|
458
|
+
# @!attribute [rw] name
|
459
|
+
# @return [::String]
|
460
|
+
# The name of the backup being created.
|
461
|
+
# @!attribute [rw] source_table
|
462
|
+
# @return [::String]
|
463
|
+
# The name of the table the backup is created from.
|
464
|
+
# @!attribute [rw] start_time
|
465
|
+
# @return [::Google::Protobuf::Timestamp]
|
466
|
+
# The time at which this operation started.
|
467
|
+
# @!attribute [rw] end_time
|
468
|
+
# @return [::Google::Protobuf::Timestamp]
|
469
|
+
# If set, the time at which this operation finished or was cancelled.
|
470
|
+
class CreateBackupMetadata
|
471
|
+
include ::Google::Protobuf::MessageExts
|
472
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
473
|
+
end
|
474
|
+
|
475
|
+
# The request for
|
476
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#get_backup GetBackup}.
|
477
|
+
# @!attribute [rw] name
|
478
|
+
# @return [::String]
|
479
|
+
# Required. Name of the backup.
|
480
|
+
# Values are of the form
|
481
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
|
482
|
+
class GetBackupRequest
|
483
|
+
include ::Google::Protobuf::MessageExts
|
484
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
485
|
+
end
|
486
|
+
|
487
|
+
# The request for
|
488
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#update_backup UpdateBackup}.
|
489
|
+
# @!attribute [rw] backup
|
490
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::Backup]
|
491
|
+
# Required. The backup to update. `backup.name`, and the fields to be updated
|
492
|
+
# as specified by `update_mask` are required. Other fields are ignored.
|
493
|
+
# Update is only supported for the following fields:
|
494
|
+
# * `backup.expire_time`.
|
495
|
+
# @!attribute [rw] update_mask
|
496
|
+
# @return [::Google::Protobuf::FieldMask]
|
497
|
+
# Required. A mask specifying which fields (e.g. `expire_time`) in the
|
498
|
+
# Backup resource should be updated. This mask is relative to the Backup
|
499
|
+
# resource, not to the request message. The field mask must always be
|
500
|
+
# specified; this prevents any future fields from being erased accidentally
|
501
|
+
# by clients that do not know about them.
|
502
|
+
class UpdateBackupRequest
|
503
|
+
include ::Google::Protobuf::MessageExts
|
504
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
505
|
+
end
|
506
|
+
|
507
|
+
# The request for
|
508
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#delete_backup DeleteBackup}.
|
509
|
+
# @!attribute [rw] name
|
510
|
+
# @return [::String]
|
511
|
+
# Required. Name of the backup to delete.
|
512
|
+
# Values are of the form
|
513
|
+
# `projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}`.
|
514
|
+
class DeleteBackupRequest
|
515
|
+
include ::Google::Protobuf::MessageExts
|
516
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
517
|
+
end
|
518
|
+
|
519
|
+
# The request for
|
520
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups}.
|
521
|
+
# @!attribute [rw] parent
|
522
|
+
# @return [::String]
|
523
|
+
# Required. The cluster to list backups from. Values are of the
|
524
|
+
# form `projects/{project}/instances/{instance}/clusters/{cluster}`.
|
525
|
+
# Use `{cluster} = '-'` to list backups for all clusters in an instance,
|
526
|
+
# e.g., `projects/{project}/instances/{instance}/clusters/-`.
|
527
|
+
# @!attribute [rw] filter
|
528
|
+
# @return [::String]
|
529
|
+
# A filter expression that filters backups listed in the response.
|
530
|
+
# The expression must specify the field name, a comparison operator,
|
531
|
+
# and the value that you want to use for filtering. The value must be a
|
532
|
+
# string, a number, or a boolean. The comparison operator must be
|
533
|
+
# <, >, <=, >=, !=, =, or :. Colon ‘:’ represents a HAS operator which is
|
534
|
+
# roughly synonymous with equality. Filter rules are case insensitive.
|
535
|
+
#
|
536
|
+
# The fields eligible for filtering are:
|
537
|
+
# * `name`
|
538
|
+
# * `source_table`
|
539
|
+
# * `state`
|
540
|
+
# * `start_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
|
541
|
+
# * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
|
542
|
+
# * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
|
543
|
+
# * `size_bytes`
|
544
|
+
#
|
545
|
+
# To filter on multiple expressions, provide each separate expression within
|
546
|
+
# parentheses. By default, each expression is an AND expression. However,
|
547
|
+
# you can include AND, OR, and NOT expressions explicitly.
|
548
|
+
#
|
549
|
+
# Some examples of using filters are:
|
550
|
+
#
|
551
|
+
# * `name:"exact"` --> The backup's name is the string "exact".
|
552
|
+
# * `name:howl` --> The backup's name contains the string "howl".
|
553
|
+
# * `source_table:prod`
|
554
|
+
# --> The source_table's name contains the string "prod".
|
555
|
+
# * `state:CREATING` --> The backup is pending creation.
|
556
|
+
# * `state:READY` --> The backup is fully created and ready for use.
|
557
|
+
# * `(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")`
|
558
|
+
# --> The backup name contains the string "howl" and start_time
|
559
|
+
# of the backup is before 2018-03-28T14:50:00Z.
|
560
|
+
# * `size_bytes > 10000000000` --> The backup's size is greater than 10GB
|
561
|
+
# @!attribute [rw] order_by
|
562
|
+
# @return [::String]
|
563
|
+
# An expression for specifying the sort order of the results of the request.
|
564
|
+
# The string value should specify one or more fields in
|
565
|
+
# {::Google::Cloud::Bigtable::Admin::V2::Backup Backup}. The full syntax is described at
|
566
|
+
# https://aip.dev/132#ordering.
|
567
|
+
#
|
568
|
+
# Fields supported are:
|
569
|
+
# * name
|
570
|
+
# * source_table
|
571
|
+
# * expire_time
|
572
|
+
# * start_time
|
573
|
+
# * end_time
|
574
|
+
# * size_bytes
|
575
|
+
# * state
|
576
|
+
#
|
577
|
+
# For example, "start_time". The default sorting order is ascending.
|
578
|
+
# To specify descending order for the field, a suffix " desc" should
|
579
|
+
# be appended to the field name. For example, "start_time desc".
|
580
|
+
# Redundant space characters in the syntax are insigificant.
|
581
|
+
#
|
582
|
+
# If order_by is empty, results will be sorted by `start_time` in descending
|
583
|
+
# order starting from the most recently created backup.
|
584
|
+
# @!attribute [rw] page_size
|
585
|
+
# @return [::Integer]
|
586
|
+
# Number of backups to be returned in the response. If 0 or
|
587
|
+
# less, defaults to the server's maximum allowed page size.
|
588
|
+
# @!attribute [rw] page_token
|
589
|
+
# @return [::String]
|
590
|
+
# If non-empty, `page_token` should contain a
|
591
|
+
# {::Google::Cloud::Bigtable::Admin::V2::ListBackupsResponse#next_page_token next_page_token}
|
592
|
+
# from a previous
|
593
|
+
# {::Google::Cloud::Bigtable::Admin::V2::ListBackupsResponse ListBackupsResponse} to the
|
594
|
+
# same `parent` and with the same `filter`.
|
595
|
+
class ListBackupsRequest
|
596
|
+
include ::Google::Protobuf::MessageExts
|
597
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
598
|
+
end
|
599
|
+
|
600
|
+
# The response for
|
601
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups}.
|
602
|
+
# @!attribute [rw] backups
|
603
|
+
# @return [::Array<::Google::Cloud::Bigtable::Admin::V2::Backup>]
|
604
|
+
# The list of matching backups.
|
605
|
+
# @!attribute [rw] next_page_token
|
606
|
+
# @return [::String]
|
607
|
+
# `next_page_token` can be sent in a subsequent
|
608
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#list_backups ListBackups} call
|
609
|
+
# to fetch more of the matching backups.
|
610
|
+
class ListBackupsResponse
|
611
|
+
include ::Google::Protobuf::MessageExts
|
612
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
613
|
+
end
|
614
|
+
|
615
|
+
# The request for
|
616
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}.
|
617
|
+
# @!attribute [rw] parent
|
618
|
+
# @return [::String]
|
619
|
+
# Required. The name of the instance in which to create the restored
|
620
|
+
# table. This instance must be the parent of the source backup. Values are
|
621
|
+
# of the form `projects/<project>/instances/<instance>`.
|
622
|
+
# @!attribute [rw] table_id
|
623
|
+
# @return [::String]
|
624
|
+
# Required. The id of the table to create and restore to. This
|
625
|
+
# table must not already exist. The `table_id` appended to
|
626
|
+
# `parent` forms the full table name of the form
|
627
|
+
# `projects/<project>/instances/<instance>/tables/<table_id>`.
|
628
|
+
# @!attribute [rw] backup
|
629
|
+
# @return [::String]
|
630
|
+
# Name of the backup from which to restore. Values are of the form
|
631
|
+
# `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
|
632
|
+
class RestoreTableRequest
|
633
|
+
include ::Google::Protobuf::MessageExts
|
634
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
635
|
+
end
|
636
|
+
|
637
|
+
# Metadata type for the long-running operation returned by
|
638
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}.
|
639
|
+
# @!attribute [rw] name
|
640
|
+
# @return [::String]
|
641
|
+
# Name of the table being created and restored to.
|
642
|
+
# @!attribute [rw] source_type
|
643
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::RestoreSourceType]
|
644
|
+
# The type of the restore source.
|
645
|
+
# @!attribute [rw] backup_info
|
646
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::BackupInfo]
|
647
|
+
# @!attribute [rw] optimize_table_operation_name
|
648
|
+
# @return [::String]
|
649
|
+
# If exists, the name of the long-running operation that will be used to
|
650
|
+
# track the post-restore optimization process to optimize the performance of
|
651
|
+
# the restored table. The metadata type of the long-running operation is
|
652
|
+
# [OptimizeRestoreTableMetadata][]. The response type is
|
653
|
+
# {::Google::Protobuf::Empty Empty}. This long-running operation may be
|
654
|
+
# automatically created by the system if applicable after the
|
655
|
+
# RestoreTable long-running operation completes successfully. This operation
|
656
|
+
# may not be created if the table is already optimized or the restore was
|
657
|
+
# not successful.
|
658
|
+
# @!attribute [rw] progress
|
659
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::OperationProgress]
|
660
|
+
# The progress of the
|
661
|
+
# {::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client#restore_table RestoreTable}
|
662
|
+
# operation.
|
663
|
+
class RestoreTableMetadata
|
664
|
+
include ::Google::Protobuf::MessageExts
|
665
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
666
|
+
end
|
667
|
+
|
668
|
+
# Metadata type for the long-running operation used to track the progress
|
669
|
+
# of optimizations performed on a newly restored table. This long-running
|
670
|
+
# operation is automatically created by the system after the successful
|
671
|
+
# completion of a table restore, and cannot be cancelled.
|
672
|
+
# @!attribute [rw] name
|
673
|
+
# @return [::String]
|
674
|
+
# Name of the restored table being optimized.
|
675
|
+
# @!attribute [rw] progress
|
676
|
+
# @return [::Google::Cloud::Bigtable::Admin::V2::OperationProgress]
|
677
|
+
# The progress of the post-restore optimizations.
|
678
|
+
class OptimizeRestoredTableMetadata
|
679
|
+
include ::Google::Protobuf::MessageExts
|
680
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
681
|
+
end
|
682
|
+
end
|
683
|
+
end
|
684
|
+
end
|
685
|
+
end
|
686
|
+
end
|