google-apis-bigtableadmin_v2 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1719 @@
1
+ # Copyright 2020 Google LLC
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+
15
+ require 'google/apis/core/base_service'
16
+ require 'google/apis/core/json_representation'
17
+ require 'google/apis/core/hashable'
18
+ require 'google/apis/errors'
19
+
20
+ module Google
21
+ module Apis
22
+ module BigtableadminV2
23
+ # Cloud Bigtable Admin API
24
+ #
25
+ # Administer your Cloud Bigtable tables and instances.
26
+ #
27
+ # @example
28
+ # require 'google/apis/bigtableadmin_v2'
29
+ #
30
+ # Bigtableadmin = Google::Apis::BigtableadminV2 # Alias the module
31
+ # service = Bigtableadmin::BigtableAdminService.new
32
+ #
33
+ # @see https://cloud.google.com/bigtable/
34
+ class BigtableAdminService < Google::Apis::Core::BaseService
35
+ # @return [String]
36
+ # API key. Your API key identifies your project and provides you with API access,
37
+ # quota, and reports. Required unless you provide an OAuth 2.0 token.
38
+ attr_accessor :key
39
+
40
+ # @return [String]
41
+ # Available to use for quota purposes for server-side applications. Can be any
42
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
43
+ attr_accessor :quota_user
44
+
45
+ def initialize
46
+ super('https://bigtableadmin.googleapis.com/', '',
47
+ client_name: 'google-apis-bigtableadmin_v2',
48
+ client_version: Google::Apis::BigtableadminV2::GEM_VERSION)
49
+ @batch_path = 'batch'
50
+ end
51
+
52
+ # Starts asynchronous cancellation on a long-running operation. The server makes
53
+ # a best effort to cancel the operation, but success is not guaranteed. If the
54
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
55
+ # Clients can use Operations.GetOperation or other methods to check whether the
56
+ # cancellation succeeded or whether the operation completed despite cancellation.
57
+ # On successful cancellation, the operation is not deleted; instead, it becomes
58
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
59
+ # corresponding to `Code.CANCELLED`.
60
+ # @param [String] name
61
+ # The name of the operation resource to be cancelled.
62
+ # @param [String] fields
63
+ # Selector specifying which fields to include in a partial response.
64
+ # @param [String] quota_user
65
+ # Available to use for quota purposes for server-side applications. Can be any
66
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
67
+ # @param [Google::Apis::RequestOptions] options
68
+ # Request-specific options
69
+ #
70
+ # @yield [result, err] Result & error if block supplied
71
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
72
+ # @yieldparam err [StandardError] error object if request failed
73
+ #
74
+ # @return [Google::Apis::BigtableadminV2::Empty]
75
+ #
76
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
77
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
78
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
79
+ def cancel_operation(name, fields: nil, quota_user: nil, options: nil, &block)
80
+ command = make_simple_command(:post, 'v2/{+name}:cancel', options)
81
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
82
+ command.response_class = Google::Apis::BigtableadminV2::Empty
83
+ command.params['name'] = name unless name.nil?
84
+ command.query['fields'] = fields unless fields.nil?
85
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
86
+ execute_or_queue_command(command, &block)
87
+ end
88
+
89
+ # Deletes a long-running operation. This method indicates that the client is no
90
+ # longer interested in the operation result. It does not cancel the operation.
91
+ # If the server doesn't support this method, it returns `google.rpc.Code.
92
+ # UNIMPLEMENTED`.
93
+ # @param [String] name
94
+ # The name of the operation resource to be deleted.
95
+ # @param [String] fields
96
+ # Selector specifying which fields to include in a partial response.
97
+ # @param [String] quota_user
98
+ # Available to use for quota purposes for server-side applications. Can be any
99
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
100
+ # @param [Google::Apis::RequestOptions] options
101
+ # Request-specific options
102
+ #
103
+ # @yield [result, err] Result & error if block supplied
104
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
105
+ # @yieldparam err [StandardError] error object if request failed
106
+ #
107
+ # @return [Google::Apis::BigtableadminV2::Empty]
108
+ #
109
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
110
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
111
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
112
+ def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block)
113
+ command = make_simple_command(:delete, 'v2/{+name}', options)
114
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
115
+ command.response_class = Google::Apis::BigtableadminV2::Empty
116
+ command.params['name'] = name unless name.nil?
117
+ command.query['fields'] = fields unless fields.nil?
118
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
119
+ execute_or_queue_command(command, &block)
120
+ end
121
+
122
+ # Gets the latest state of a long-running operation. Clients can use this method
123
+ # to poll the operation result at intervals as recommended by the API service.
124
+ # @param [String] name
125
+ # The name of the operation resource.
126
+ # @param [String] fields
127
+ # Selector specifying which fields to include in a partial response.
128
+ # @param [String] quota_user
129
+ # Available to use for quota purposes for server-side applications. Can be any
130
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
131
+ # @param [Google::Apis::RequestOptions] options
132
+ # Request-specific options
133
+ #
134
+ # @yield [result, err] Result & error if block supplied
135
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
136
+ # @yieldparam err [StandardError] error object if request failed
137
+ #
138
+ # @return [Google::Apis::BigtableadminV2::Operation]
139
+ #
140
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
141
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
142
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
143
+ def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
144
+ command = make_simple_command(:get, 'v2/{+name}', options)
145
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
146
+ command.response_class = Google::Apis::BigtableadminV2::Operation
147
+ command.params['name'] = name unless name.nil?
148
+ command.query['fields'] = fields unless fields.nil?
149
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
150
+ execute_or_queue_command(command, &block)
151
+ end
152
+
153
+ # Lists operations that match the specified filter in the request. If the server
154
+ # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name`
155
+ # binding allows API services to override the binding to use different resource
156
+ # name schemes, such as `users/*/operations`. To override the binding, API
157
+ # services can add a binding such as `"/v1/`name=users/*`/operations"` to their
158
+ # service configuration. For backwards compatibility, the default name includes
159
+ # the operations collection id, however overriding users must ensure the name
160
+ # binding is the parent resource, without the operations collection id.
161
+ # @param [String] name
162
+ # The name of the operation's parent resource.
163
+ # @param [String] filter
164
+ # The standard list filter.
165
+ # @param [Fixnum] page_size
166
+ # The standard list page size.
167
+ # @param [String] page_token
168
+ # The standard list page token.
169
+ # @param [String] fields
170
+ # Selector specifying which fields to include in a partial response.
171
+ # @param [String] quota_user
172
+ # Available to use for quota purposes for server-side applications. Can be any
173
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
174
+ # @param [Google::Apis::RequestOptions] options
175
+ # Request-specific options
176
+ #
177
+ # @yield [result, err] Result & error if block supplied
178
+ # @yieldparam result [Google::Apis::BigtableadminV2::ListOperationsResponse] parsed result object
179
+ # @yieldparam err [StandardError] error object if request failed
180
+ #
181
+ # @return [Google::Apis::BigtableadminV2::ListOperationsResponse]
182
+ #
183
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
184
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
185
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
186
+ def list_operation_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
187
+ command = make_simple_command(:get, 'v2/{+name}/operations', options)
188
+ command.response_representation = Google::Apis::BigtableadminV2::ListOperationsResponse::Representation
189
+ command.response_class = Google::Apis::BigtableadminV2::ListOperationsResponse
190
+ command.params['name'] = name unless name.nil?
191
+ command.query['filter'] = filter unless filter.nil?
192
+ command.query['pageSize'] = page_size unless page_size.nil?
193
+ command.query['pageToken'] = page_token unless page_token.nil?
194
+ command.query['fields'] = fields unless fields.nil?
195
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
196
+ execute_or_queue_command(command, &block)
197
+ end
198
+
199
+ # Create an instance within a project.
200
+ # @param [String] parent
201
+ # Required. The unique name of the project in which to create the new instance.
202
+ # Values are of the form `projects/`project``.
203
+ # @param [Google::Apis::BigtableadminV2::CreateInstanceRequest] create_instance_request_object
204
+ # @param [String] fields
205
+ # Selector specifying which fields to include in a partial response.
206
+ # @param [String] quota_user
207
+ # Available to use for quota purposes for server-side applications. Can be any
208
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
209
+ # @param [Google::Apis::RequestOptions] options
210
+ # Request-specific options
211
+ #
212
+ # @yield [result, err] Result & error if block supplied
213
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
214
+ # @yieldparam err [StandardError] error object if request failed
215
+ #
216
+ # @return [Google::Apis::BigtableadminV2::Operation]
217
+ #
218
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
219
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
220
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
221
+ def create_instance(parent, create_instance_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
222
+ command = make_simple_command(:post, 'v2/{+parent}/instances', options)
223
+ command.request_representation = Google::Apis::BigtableadminV2::CreateInstanceRequest::Representation
224
+ command.request_object = create_instance_request_object
225
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
226
+ command.response_class = Google::Apis::BigtableadminV2::Operation
227
+ command.params['parent'] = parent unless parent.nil?
228
+ command.query['fields'] = fields unless fields.nil?
229
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
230
+ execute_or_queue_command(command, &block)
231
+ end
232
+
233
+ # Delete an instance from a project.
234
+ # @param [String] name
235
+ # Required. The unique name of the instance to be deleted. Values are of the
236
+ # form `projects/`project`/instances/`instance``.
237
+ # @param [String] fields
238
+ # Selector specifying which fields to include in a partial response.
239
+ # @param [String] quota_user
240
+ # Available to use for quota purposes for server-side applications. Can be any
241
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
242
+ # @param [Google::Apis::RequestOptions] options
243
+ # Request-specific options
244
+ #
245
+ # @yield [result, err] Result & error if block supplied
246
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
247
+ # @yieldparam err [StandardError] error object if request failed
248
+ #
249
+ # @return [Google::Apis::BigtableadminV2::Empty]
250
+ #
251
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
252
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
253
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
254
+ def delete_project_instance(name, fields: nil, quota_user: nil, options: nil, &block)
255
+ command = make_simple_command(:delete, 'v2/{+name}', options)
256
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
257
+ command.response_class = Google::Apis::BigtableadminV2::Empty
258
+ command.params['name'] = name unless name.nil?
259
+ command.query['fields'] = fields unless fields.nil?
260
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
261
+ execute_or_queue_command(command, &block)
262
+ end
263
+
264
+ # Gets information about an instance.
265
+ # @param [String] name
266
+ # Required. The unique name of the requested instance. Values are of the form `
267
+ # projects/`project`/instances/`instance``.
268
+ # @param [String] fields
269
+ # Selector specifying which fields to include in a partial response.
270
+ # @param [String] quota_user
271
+ # Available to use for quota purposes for server-side applications. Can be any
272
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
273
+ # @param [Google::Apis::RequestOptions] options
274
+ # Request-specific options
275
+ #
276
+ # @yield [result, err] Result & error if block supplied
277
+ # @yieldparam result [Google::Apis::BigtableadminV2::Instance] parsed result object
278
+ # @yieldparam err [StandardError] error object if request failed
279
+ #
280
+ # @return [Google::Apis::BigtableadminV2::Instance]
281
+ #
282
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
283
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
284
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
285
+ def get_project_instance(name, fields: nil, quota_user: nil, options: nil, &block)
286
+ command = make_simple_command(:get, 'v2/{+name}', options)
287
+ command.response_representation = Google::Apis::BigtableadminV2::Instance::Representation
288
+ command.response_class = Google::Apis::BigtableadminV2::Instance
289
+ command.params['name'] = name unless name.nil?
290
+ command.query['fields'] = fields unless fields.nil?
291
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
292
+ execute_or_queue_command(command, &block)
293
+ end
294
+
295
+ # Gets the access control policy for an instance resource. Returns an empty
296
+ # policy if an instance exists but does not have a policy set.
297
+ # @param [String] resource
298
+ # REQUIRED: The resource for which the policy is being requested. See the
299
+ # operation documentation for the appropriate value for this field.
300
+ # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object
301
+ # @param [String] fields
302
+ # Selector specifying which fields to include in a partial response.
303
+ # @param [String] quota_user
304
+ # Available to use for quota purposes for server-side applications. Can be any
305
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
306
+ # @param [Google::Apis::RequestOptions] options
307
+ # Request-specific options
308
+ #
309
+ # @yield [result, err] Result & error if block supplied
310
+ # @yieldparam result [Google::Apis::BigtableadminV2::Policy] parsed result object
311
+ # @yieldparam err [StandardError] error object if request failed
312
+ #
313
+ # @return [Google::Apis::BigtableadminV2::Policy]
314
+ #
315
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
316
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
317
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
318
+ def get_instance_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
319
+ command = make_simple_command(:post, 'v2/{+resource}:getIamPolicy', options)
320
+ command.request_representation = Google::Apis::BigtableadminV2::GetIamPolicyRequest::Representation
321
+ command.request_object = get_iam_policy_request_object
322
+ command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation
323
+ command.response_class = Google::Apis::BigtableadminV2::Policy
324
+ command.params['resource'] = resource unless resource.nil?
325
+ command.query['fields'] = fields unless fields.nil?
326
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
327
+ execute_or_queue_command(command, &block)
328
+ end
329
+
330
+ # Lists information about instances in a project.
331
+ # @param [String] parent
332
+ # Required. The unique name of the project for which a list of instances is
333
+ # requested. Values are of the form `projects/`project``.
334
+ # @param [String] page_token
335
+ # DEPRECATED: This field is unused and ignored.
336
+ # @param [String] fields
337
+ # Selector specifying which fields to include in a partial response.
338
+ # @param [String] quota_user
339
+ # Available to use for quota purposes for server-side applications. Can be any
340
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
341
+ # @param [Google::Apis::RequestOptions] options
342
+ # Request-specific options
343
+ #
344
+ # @yield [result, err] Result & error if block supplied
345
+ # @yieldparam result [Google::Apis::BigtableadminV2::ListInstancesResponse] parsed result object
346
+ # @yieldparam err [StandardError] error object if request failed
347
+ #
348
+ # @return [Google::Apis::BigtableadminV2::ListInstancesResponse]
349
+ #
350
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
351
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
352
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
353
+ def list_project_instances(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
354
+ command = make_simple_command(:get, 'v2/{+parent}/instances', options)
355
+ command.response_representation = Google::Apis::BigtableadminV2::ListInstancesResponse::Representation
356
+ command.response_class = Google::Apis::BigtableadminV2::ListInstancesResponse
357
+ command.params['parent'] = parent unless parent.nil?
358
+ command.query['pageToken'] = page_token unless page_token.nil?
359
+ command.query['fields'] = fields unless fields.nil?
360
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
361
+ execute_or_queue_command(command, &block)
362
+ end
363
+
364
+ # Partially updates an instance within a project. This method can modify all
365
+ # fields of an Instance and is the preferred way to update an Instance.
366
+ # @param [String] name
367
+ # The unique name of the instance. Values are of the form `projects/`project`/
368
+ # instances/a-z+[a-z0-9]`.
369
+ # @param [Google::Apis::BigtableadminV2::Instance] instance_object
370
+ # @param [String] update_mask
371
+ # Required. The subset of Instance fields which should be replaced. Must be
372
+ # explicitly set.
373
+ # @param [String] fields
374
+ # Selector specifying which fields to include in a partial response.
375
+ # @param [String] quota_user
376
+ # Available to use for quota purposes for server-side applications. Can be any
377
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
378
+ # @param [Google::Apis::RequestOptions] options
379
+ # Request-specific options
380
+ #
381
+ # @yield [result, err] Result & error if block supplied
382
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
383
+ # @yieldparam err [StandardError] error object if request failed
384
+ #
385
+ # @return [Google::Apis::BigtableadminV2::Operation]
386
+ #
387
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
388
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
389
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
390
+ def partial_project_instance_update_instance(name, instance_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
391
+ command = make_simple_command(:patch, 'v2/{+name}', options)
392
+ command.request_representation = Google::Apis::BigtableadminV2::Instance::Representation
393
+ command.request_object = instance_object
394
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
395
+ command.response_class = Google::Apis::BigtableadminV2::Operation
396
+ command.params['name'] = name unless name.nil?
397
+ command.query['updateMask'] = update_mask unless update_mask.nil?
398
+ command.query['fields'] = fields unless fields.nil?
399
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
400
+ execute_or_queue_command(command, &block)
401
+ end
402
+
403
+ # Sets the access control policy on an instance resource. Replaces any existing
404
+ # policy.
405
+ # @param [String] resource
406
+ # REQUIRED: The resource for which the policy is being specified. See the
407
+ # operation documentation for the appropriate value for this field.
408
+ # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object
409
+ # @param [String] fields
410
+ # Selector specifying which fields to include in a partial response.
411
+ # @param [String] quota_user
412
+ # Available to use for quota purposes for server-side applications. Can be any
413
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
414
+ # @param [Google::Apis::RequestOptions] options
415
+ # Request-specific options
416
+ #
417
+ # @yield [result, err] Result & error if block supplied
418
+ # @yieldparam result [Google::Apis::BigtableadminV2::Policy] parsed result object
419
+ # @yieldparam err [StandardError] error object if request failed
420
+ #
421
+ # @return [Google::Apis::BigtableadminV2::Policy]
422
+ #
423
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
424
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
425
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
426
+ def set_instance_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
427
+ command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', options)
428
+ command.request_representation = Google::Apis::BigtableadminV2::SetIamPolicyRequest::Representation
429
+ command.request_object = set_iam_policy_request_object
430
+ command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation
431
+ command.response_class = Google::Apis::BigtableadminV2::Policy
432
+ command.params['resource'] = resource unless resource.nil?
433
+ command.query['fields'] = fields unless fields.nil?
434
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
435
+ execute_or_queue_command(command, &block)
436
+ end
437
+
438
+ # Returns permissions that the caller has on the specified instance resource.
439
+ # @param [String] resource
440
+ # REQUIRED: The resource for which the policy detail is being requested. See the
441
+ # operation documentation for the appropriate value for this field.
442
+ # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object
443
+ # @param [String] fields
444
+ # Selector specifying which fields to include in a partial response.
445
+ # @param [String] quota_user
446
+ # Available to use for quota purposes for server-side applications. Can be any
447
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
448
+ # @param [Google::Apis::RequestOptions] options
449
+ # Request-specific options
450
+ #
451
+ # @yield [result, err] Result & error if block supplied
452
+ # @yieldparam result [Google::Apis::BigtableadminV2::TestIamPermissionsResponse] parsed result object
453
+ # @yieldparam err [StandardError] error object if request failed
454
+ #
455
+ # @return [Google::Apis::BigtableadminV2::TestIamPermissionsResponse]
456
+ #
457
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
458
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
459
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
460
+ def test_instance_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
461
+ command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', options)
462
+ command.request_representation = Google::Apis::BigtableadminV2::TestIamPermissionsRequest::Representation
463
+ command.request_object = test_iam_permissions_request_object
464
+ command.response_representation = Google::Apis::BigtableadminV2::TestIamPermissionsResponse::Representation
465
+ command.response_class = Google::Apis::BigtableadminV2::TestIamPermissionsResponse
466
+ command.params['resource'] = resource unless resource.nil?
467
+ command.query['fields'] = fields unless fields.nil?
468
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
469
+ execute_or_queue_command(command, &block)
470
+ end
471
+
472
+ # Updates an instance within a project. This method updates only the display
473
+ # name and type for an Instance. To update other Instance properties, such as
474
+ # labels, use PartialUpdateInstance.
475
+ # @param [String] name
476
+ # The unique name of the instance. Values are of the form `projects/`project`/
477
+ # instances/a-z+[a-z0-9]`.
478
+ # @param [Google::Apis::BigtableadminV2::Instance] instance_object
479
+ # @param [String] fields
480
+ # Selector specifying which fields to include in a partial response.
481
+ # @param [String] quota_user
482
+ # Available to use for quota purposes for server-side applications. Can be any
483
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
484
+ # @param [Google::Apis::RequestOptions] options
485
+ # Request-specific options
486
+ #
487
+ # @yield [result, err] Result & error if block supplied
488
+ # @yieldparam result [Google::Apis::BigtableadminV2::Instance] parsed result object
489
+ # @yieldparam err [StandardError] error object if request failed
490
+ #
491
+ # @return [Google::Apis::BigtableadminV2::Instance]
492
+ #
493
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
494
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
495
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
496
+ def update_project_instance(name, instance_object = nil, fields: nil, quota_user: nil, options: nil, &block)
497
+ command = make_simple_command(:put, 'v2/{+name}', options)
498
+ command.request_representation = Google::Apis::BigtableadminV2::Instance::Representation
499
+ command.request_object = instance_object
500
+ command.response_representation = Google::Apis::BigtableadminV2::Instance::Representation
501
+ command.response_class = Google::Apis::BigtableadminV2::Instance
502
+ command.params['name'] = name unless name.nil?
503
+ command.query['fields'] = fields unless fields.nil?
504
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
505
+ execute_or_queue_command(command, &block)
506
+ end
507
+
508
+ # Creates an app profile within an instance.
509
+ # @param [String] parent
510
+ # Required. The unique name of the instance in which to create the new app
511
+ # profile. Values are of the form `projects/`project`/instances/`instance``.
512
+ # @param [Google::Apis::BigtableadminV2::AppProfile] app_profile_object
513
+ # @param [String] app_profile_id
514
+ # Required. The ID to be used when referring to the new app profile within its
515
+ # instance, e.g., just `myprofile` rather than `projects/myproject/instances/
516
+ # myinstance/appProfiles/myprofile`.
517
+ # @param [Boolean] ignore_warnings
518
+ # If true, ignore safety checks when creating the app profile.
519
+ # @param [String] fields
520
+ # Selector specifying which fields to include in a partial response.
521
+ # @param [String] quota_user
522
+ # Available to use for quota purposes for server-side applications. Can be any
523
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
524
+ # @param [Google::Apis::RequestOptions] options
525
+ # Request-specific options
526
+ #
527
+ # @yield [result, err] Result & error if block supplied
528
+ # @yieldparam result [Google::Apis::BigtableadminV2::AppProfile] parsed result object
529
+ # @yieldparam err [StandardError] error object if request failed
530
+ #
531
+ # @return [Google::Apis::BigtableadminV2::AppProfile]
532
+ #
533
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
534
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
535
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
536
+ def create_project_instance_app_profile(parent, app_profile_object = nil, app_profile_id: nil, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil, &block)
537
+ command = make_simple_command(:post, 'v2/{+parent}/appProfiles', options)
538
+ command.request_representation = Google::Apis::BigtableadminV2::AppProfile::Representation
539
+ command.request_object = app_profile_object
540
+ command.response_representation = Google::Apis::BigtableadminV2::AppProfile::Representation
541
+ command.response_class = Google::Apis::BigtableadminV2::AppProfile
542
+ command.params['parent'] = parent unless parent.nil?
543
+ command.query['appProfileId'] = app_profile_id unless app_profile_id.nil?
544
+ command.query['ignoreWarnings'] = ignore_warnings unless ignore_warnings.nil?
545
+ command.query['fields'] = fields unless fields.nil?
546
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
547
+ execute_or_queue_command(command, &block)
548
+ end
549
+
550
+ # Deletes an app profile from an instance.
551
+ # @param [String] name
552
+ # Required. The unique name of the app profile to be deleted. Values are of the
553
+ # form `projects/`project`/instances/`instance`/appProfiles/`app_profile``.
554
+ # @param [Boolean] ignore_warnings
555
+ # Required. If true, ignore safety checks when deleting the app profile.
556
+ # @param [String] fields
557
+ # Selector specifying which fields to include in a partial response.
558
+ # @param [String] quota_user
559
+ # Available to use for quota purposes for server-side applications. Can be any
560
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
561
+ # @param [Google::Apis::RequestOptions] options
562
+ # Request-specific options
563
+ #
564
+ # @yield [result, err] Result & error if block supplied
565
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
566
+ # @yieldparam err [StandardError] error object if request failed
567
+ #
568
+ # @return [Google::Apis::BigtableadminV2::Empty]
569
+ #
570
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
571
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
572
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
573
+ def delete_project_instance_app_profile(name, ignore_warnings: nil, fields: nil, quota_user: nil, options: nil, &block)
574
+ command = make_simple_command(:delete, 'v2/{+name}', options)
575
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
576
+ command.response_class = Google::Apis::BigtableadminV2::Empty
577
+ command.params['name'] = name unless name.nil?
578
+ command.query['ignoreWarnings'] = ignore_warnings unless ignore_warnings.nil?
579
+ command.query['fields'] = fields unless fields.nil?
580
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
581
+ execute_or_queue_command(command, &block)
582
+ end
583
+
584
+ # Gets information about an app profile.
585
+ # @param [String] name
586
+ # Required. The unique name of the requested app profile. Values are of the form
587
+ # `projects/`project`/instances/`instance`/appProfiles/`app_profile``.
588
+ # @param [String] fields
589
+ # Selector specifying which fields to include in a partial response.
590
+ # @param [String] quota_user
591
+ # Available to use for quota purposes for server-side applications. Can be any
592
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
593
+ # @param [Google::Apis::RequestOptions] options
594
+ # Request-specific options
595
+ #
596
+ # @yield [result, err] Result & error if block supplied
597
+ # @yieldparam result [Google::Apis::BigtableadminV2::AppProfile] parsed result object
598
+ # @yieldparam err [StandardError] error object if request failed
599
+ #
600
+ # @return [Google::Apis::BigtableadminV2::AppProfile]
601
+ #
602
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
603
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
604
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
605
+ def get_project_instance_app_profile(name, fields: nil, quota_user: nil, options: nil, &block)
606
+ command = make_simple_command(:get, 'v2/{+name}', options)
607
+ command.response_representation = Google::Apis::BigtableadminV2::AppProfile::Representation
608
+ command.response_class = Google::Apis::BigtableadminV2::AppProfile
609
+ command.params['name'] = name unless name.nil?
610
+ command.query['fields'] = fields unless fields.nil?
611
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
612
+ execute_or_queue_command(command, &block)
613
+ end
614
+
615
+ # Lists information about app profiles in an instance.
616
+ # @param [String] parent
617
+ # Required. The unique name of the instance for which a list of app profiles is
618
+ # requested. Values are of the form `projects/`project`/instances/`instance``.
619
+ # Use ``instance` = '-'` to list AppProfiles for all Instances in a project, e.g.
620
+ # , `projects/myproject/instances/-`.
621
+ # @param [Fixnum] page_size
622
+ # Maximum number of results per page. A page_size of zero lets the server choose
623
+ # the number of items to return. A page_size which is strictly positive will
624
+ # return at most that many items. A negative page_size will cause an error.
625
+ # Following the first request, subsequent paginated calls are not required to
626
+ # pass a page_size. If a page_size is set in subsequent calls, it must match the
627
+ # page_size given in the first request.
628
+ # @param [String] page_token
629
+ # The value of `next_page_token` returned by a previous call.
630
+ # @param [String] fields
631
+ # Selector specifying which fields to include in a partial response.
632
+ # @param [String] quota_user
633
+ # Available to use for quota purposes for server-side applications. Can be any
634
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
635
+ # @param [Google::Apis::RequestOptions] options
636
+ # Request-specific options
637
+ #
638
+ # @yield [result, err] Result & error if block supplied
639
+ # @yieldparam result [Google::Apis::BigtableadminV2::ListAppProfilesResponse] parsed result object
640
+ # @yieldparam err [StandardError] error object if request failed
641
+ #
642
+ # @return [Google::Apis::BigtableadminV2::ListAppProfilesResponse]
643
+ #
644
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
645
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
646
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
647
+ def list_project_instance_app_profiles(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
648
+ command = make_simple_command(:get, 'v2/{+parent}/appProfiles', options)
649
+ command.response_representation = Google::Apis::BigtableadminV2::ListAppProfilesResponse::Representation
650
+ command.response_class = Google::Apis::BigtableadminV2::ListAppProfilesResponse
651
+ command.params['parent'] = parent unless parent.nil?
652
+ command.query['pageSize'] = page_size unless page_size.nil?
653
+ command.query['pageToken'] = page_token unless page_token.nil?
654
+ command.query['fields'] = fields unless fields.nil?
655
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
656
+ execute_or_queue_command(command, &block)
657
+ end
658
+
659
+ # Updates an app profile within an instance.
660
+ # @param [String] name
661
+ # The unique name of the app profile. Values are of the form `projects/`project`/
662
+ # instances/`instance`/appProfiles/_a-zA-Z0-9*`.
663
+ # @param [Google::Apis::BigtableadminV2::AppProfile] app_profile_object
664
+ # @param [Boolean] ignore_warnings
665
+ # If true, ignore safety checks when updating the app profile.
666
+ # @param [String] update_mask
667
+ # Required. The subset of app profile fields which should be replaced. If unset,
668
+ # all fields will be replaced.
669
+ # @param [String] fields
670
+ # Selector specifying which fields to include in a partial response.
671
+ # @param [String] quota_user
672
+ # Available to use for quota purposes for server-side applications. Can be any
673
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
674
+ # @param [Google::Apis::RequestOptions] options
675
+ # Request-specific options
676
+ #
677
+ # @yield [result, err] Result & error if block supplied
678
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
679
+ # @yieldparam err [StandardError] error object if request failed
680
+ #
681
+ # @return [Google::Apis::BigtableadminV2::Operation]
682
+ #
683
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
684
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
685
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
686
+ def patch_project_instance_app_profile(name, app_profile_object = nil, ignore_warnings: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
687
+ command = make_simple_command(:patch, 'v2/{+name}', options)
688
+ command.request_representation = Google::Apis::BigtableadminV2::AppProfile::Representation
689
+ command.request_object = app_profile_object
690
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
691
+ command.response_class = Google::Apis::BigtableadminV2::Operation
692
+ command.params['name'] = name unless name.nil?
693
+ command.query['ignoreWarnings'] = ignore_warnings unless ignore_warnings.nil?
694
+ command.query['updateMask'] = update_mask unless update_mask.nil?
695
+ command.query['fields'] = fields unless fields.nil?
696
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
697
+ execute_or_queue_command(command, &block)
698
+ end
699
+
700
+ # Creates a cluster within an instance.
701
+ # @param [String] parent
702
+ # Required. The unique name of the instance in which to create the new cluster.
703
+ # Values are of the form `projects/`project`/instances/`instance``.
704
+ # @param [Google::Apis::BigtableadminV2::Cluster] cluster_object
705
+ # @param [String] cluster_id
706
+ # Required. The ID to be used when referring to the new cluster within its
707
+ # instance, e.g., just `mycluster` rather than `projects/myproject/instances/
708
+ # myinstance/clusters/mycluster`.
709
+ # @param [String] fields
710
+ # Selector specifying which fields to include in a partial response.
711
+ # @param [String] quota_user
712
+ # Available to use for quota purposes for server-side applications. Can be any
713
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
714
+ # @param [Google::Apis::RequestOptions] options
715
+ # Request-specific options
716
+ #
717
+ # @yield [result, err] Result & error if block supplied
718
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
719
+ # @yieldparam err [StandardError] error object if request failed
720
+ #
721
+ # @return [Google::Apis::BigtableadminV2::Operation]
722
+ #
723
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
724
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
725
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
726
+ def create_project_instance_cluster(parent, cluster_object = nil, cluster_id: nil, fields: nil, quota_user: nil, options: nil, &block)
727
+ command = make_simple_command(:post, 'v2/{+parent}/clusters', options)
728
+ command.request_representation = Google::Apis::BigtableadminV2::Cluster::Representation
729
+ command.request_object = cluster_object
730
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
731
+ command.response_class = Google::Apis::BigtableadminV2::Operation
732
+ command.params['parent'] = parent unless parent.nil?
733
+ command.query['clusterId'] = cluster_id unless cluster_id.nil?
734
+ command.query['fields'] = fields unless fields.nil?
735
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
736
+ execute_or_queue_command(command, &block)
737
+ end
738
+
739
+ # Deletes a cluster from an instance.
740
+ # @param [String] name
741
+ # Required. The unique name of the cluster to be deleted. Values are of the form
742
+ # `projects/`project`/instances/`instance`/clusters/`cluster``.
743
+ # @param [String] fields
744
+ # Selector specifying which fields to include in a partial response.
745
+ # @param [String] quota_user
746
+ # Available to use for quota purposes for server-side applications. Can be any
747
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
748
+ # @param [Google::Apis::RequestOptions] options
749
+ # Request-specific options
750
+ #
751
+ # @yield [result, err] Result & error if block supplied
752
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
753
+ # @yieldparam err [StandardError] error object if request failed
754
+ #
755
+ # @return [Google::Apis::BigtableadminV2::Empty]
756
+ #
757
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
758
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
759
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
760
+ def delete_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil, &block)
761
+ command = make_simple_command(:delete, 'v2/{+name}', options)
762
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
763
+ command.response_class = Google::Apis::BigtableadminV2::Empty
764
+ command.params['name'] = name unless name.nil?
765
+ command.query['fields'] = fields unless fields.nil?
766
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
767
+ execute_or_queue_command(command, &block)
768
+ end
769
+
770
+ # Gets information about a cluster.
771
+ # @param [String] name
772
+ # Required. The unique name of the requested cluster. Values are of the form `
773
+ # projects/`project`/instances/`instance`/clusters/`cluster``.
774
+ # @param [String] fields
775
+ # Selector specifying which fields to include in a partial response.
776
+ # @param [String] quota_user
777
+ # Available to use for quota purposes for server-side applications. Can be any
778
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
779
+ # @param [Google::Apis::RequestOptions] options
780
+ # Request-specific options
781
+ #
782
+ # @yield [result, err] Result & error if block supplied
783
+ # @yieldparam result [Google::Apis::BigtableadminV2::Cluster] parsed result object
784
+ # @yieldparam err [StandardError] error object if request failed
785
+ #
786
+ # @return [Google::Apis::BigtableadminV2::Cluster]
787
+ #
788
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
789
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
790
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
791
+ def get_project_instance_cluster(name, fields: nil, quota_user: nil, options: nil, &block)
792
+ command = make_simple_command(:get, 'v2/{+name}', options)
793
+ command.response_representation = Google::Apis::BigtableadminV2::Cluster::Representation
794
+ command.response_class = Google::Apis::BigtableadminV2::Cluster
795
+ command.params['name'] = name unless name.nil?
796
+ command.query['fields'] = fields unless fields.nil?
797
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
798
+ execute_or_queue_command(command, &block)
799
+ end
800
+
801
+ # Lists information about clusters in an instance.
802
+ # @param [String] parent
803
+ # Required. The unique name of the instance for which a list of clusters is
804
+ # requested. Values are of the form `projects/`project`/instances/`instance``.
805
+ # Use ``instance` = '-'` to list Clusters for all Instances in a project, e.g., `
806
+ # projects/myproject/instances/-`.
807
+ # @param [String] page_token
808
+ # DEPRECATED: This field is unused and ignored.
809
+ # @param [String] fields
810
+ # Selector specifying which fields to include in a partial response.
811
+ # @param [String] quota_user
812
+ # Available to use for quota purposes for server-side applications. Can be any
813
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
814
+ # @param [Google::Apis::RequestOptions] options
815
+ # Request-specific options
816
+ #
817
+ # @yield [result, err] Result & error if block supplied
818
+ # @yieldparam result [Google::Apis::BigtableadminV2::ListClustersResponse] parsed result object
819
+ # @yieldparam err [StandardError] error object if request failed
820
+ #
821
+ # @return [Google::Apis::BigtableadminV2::ListClustersResponse]
822
+ #
823
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
824
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
825
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
826
+ def list_project_instance_clusters(parent, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
827
+ command = make_simple_command(:get, 'v2/{+parent}/clusters', options)
828
+ command.response_representation = Google::Apis::BigtableadminV2::ListClustersResponse::Representation
829
+ command.response_class = Google::Apis::BigtableadminV2::ListClustersResponse
830
+ command.params['parent'] = parent unless parent.nil?
831
+ command.query['pageToken'] = page_token unless page_token.nil?
832
+ command.query['fields'] = fields unless fields.nil?
833
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
834
+ execute_or_queue_command(command, &block)
835
+ end
836
+
837
+ # Updates a cluster within an instance.
838
+ # @param [String] name
839
+ # The unique name of the cluster. Values are of the form `projects/`project`/
840
+ # instances/`instance`/clusters/a-z*`.
841
+ # @param [Google::Apis::BigtableadminV2::Cluster] cluster_object
842
+ # @param [String] fields
843
+ # Selector specifying which fields to include in a partial response.
844
+ # @param [String] quota_user
845
+ # Available to use for quota purposes for server-side applications. Can be any
846
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
847
+ # @param [Google::Apis::RequestOptions] options
848
+ # Request-specific options
849
+ #
850
+ # @yield [result, err] Result & error if block supplied
851
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
852
+ # @yieldparam err [StandardError] error object if request failed
853
+ #
854
+ # @return [Google::Apis::BigtableadminV2::Operation]
855
+ #
856
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
857
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
858
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
859
+ def update_project_instance_cluster(name, cluster_object = nil, fields: nil, quota_user: nil, options: nil, &block)
860
+ command = make_simple_command(:put, 'v2/{+name}', options)
861
+ command.request_representation = Google::Apis::BigtableadminV2::Cluster::Representation
862
+ command.request_object = cluster_object
863
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
864
+ command.response_class = Google::Apis::BigtableadminV2::Operation
865
+ command.params['name'] = name unless name.nil?
866
+ command.query['fields'] = fields unless fields.nil?
867
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
868
+ execute_or_queue_command(command, &block)
869
+ end
870
+
871
+ # Starts creating a new Cloud Bigtable Backup. The returned backup long-running
872
+ # operation can be used to track creation of the backup. The metadata field type
873
+ # is CreateBackupMetadata. The response field type is Backup, if successful.
874
+ # Cancelling the returned operation will stop the creation and delete the backup.
875
+ # @param [String] parent
876
+ # Required. This must be one of the clusters in the instance in which this table
877
+ # is located. The backup will be stored in this cluster. Values are of the form `
878
+ # projects/`project`/instances/`instance`/clusters/`cluster``.
879
+ # @param [Google::Apis::BigtableadminV2::Backup] backup_object
880
+ # @param [String] backup_id
881
+ # Required. The id of the backup to be created. The `backup_id` along with the
882
+ # parent `parent` are combined as `parent`/backups/`backup_id` to create the
883
+ # full backup name, of the form: `projects/`project`/instances/`instance`/
884
+ # clusters/`cluster`/backups/`backup_id``. This string must be between 1 and 50
885
+ # characters in length and match the regex _a-zA-Z0-9*.
886
+ # @param [String] fields
887
+ # Selector specifying which fields to include in a partial response.
888
+ # @param [String] quota_user
889
+ # Available to use for quota purposes for server-side applications. Can be any
890
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
891
+ # @param [Google::Apis::RequestOptions] options
892
+ # Request-specific options
893
+ #
894
+ # @yield [result, err] Result & error if block supplied
895
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
896
+ # @yieldparam err [StandardError] error object if request failed
897
+ #
898
+ # @return [Google::Apis::BigtableadminV2::Operation]
899
+ #
900
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
901
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
902
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
903
+ def create_project_instance_cluster_backup(parent, backup_object = nil, backup_id: nil, fields: nil, quota_user: nil, options: nil, &block)
904
+ command = make_simple_command(:post, 'v2/{+parent}/backups', options)
905
+ command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation
906
+ command.request_object = backup_object
907
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
908
+ command.response_class = Google::Apis::BigtableadminV2::Operation
909
+ command.params['parent'] = parent unless parent.nil?
910
+ command.query['backupId'] = backup_id unless backup_id.nil?
911
+ command.query['fields'] = fields unless fields.nil?
912
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
913
+ execute_or_queue_command(command, &block)
914
+ end
915
+
916
+ # Deletes a pending or completed Cloud Bigtable backup.
917
+ # @param [String] name
918
+ # Required. Name of the backup to delete. Values are of the form `projects/`
919
+ # project`/instances/`instance`/clusters/`cluster`/backups/`backup``.
920
+ # @param [String] fields
921
+ # Selector specifying which fields to include in a partial response.
922
+ # @param [String] quota_user
923
+ # Available to use for quota purposes for server-side applications. Can be any
924
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
925
+ # @param [Google::Apis::RequestOptions] options
926
+ # Request-specific options
927
+ #
928
+ # @yield [result, err] Result & error if block supplied
929
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
930
+ # @yieldparam err [StandardError] error object if request failed
931
+ #
932
+ # @return [Google::Apis::BigtableadminV2::Empty]
933
+ #
934
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
935
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
936
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
937
+ def delete_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block)
938
+ command = make_simple_command(:delete, 'v2/{+name}', options)
939
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
940
+ command.response_class = Google::Apis::BigtableadminV2::Empty
941
+ command.params['name'] = name unless name.nil?
942
+ command.query['fields'] = fields unless fields.nil?
943
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
944
+ execute_or_queue_command(command, &block)
945
+ end
946
+
947
+ # Gets metadata on a pending or completed Cloud Bigtable Backup.
948
+ # @param [String] name
949
+ # Required. Name of the backup. Values are of the form `projects/`project`/
950
+ # instances/`instance`/clusters/`cluster`/backups/`backup``.
951
+ # @param [String] fields
952
+ # Selector specifying which fields to include in a partial response.
953
+ # @param [String] quota_user
954
+ # Available to use for quota purposes for server-side applications. Can be any
955
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
956
+ # @param [Google::Apis::RequestOptions] options
957
+ # Request-specific options
958
+ #
959
+ # @yield [result, err] Result & error if block supplied
960
+ # @yieldparam result [Google::Apis::BigtableadminV2::Backup] parsed result object
961
+ # @yieldparam err [StandardError] error object if request failed
962
+ #
963
+ # @return [Google::Apis::BigtableadminV2::Backup]
964
+ #
965
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
966
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
967
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
968
+ def get_project_instance_cluster_backup(name, fields: nil, quota_user: nil, options: nil, &block)
969
+ command = make_simple_command(:get, 'v2/{+name}', options)
970
+ command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation
971
+ command.response_class = Google::Apis::BigtableadminV2::Backup
972
+ command.params['name'] = name unless name.nil?
973
+ command.query['fields'] = fields unless fields.nil?
974
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
975
+ execute_or_queue_command(command, &block)
976
+ end
977
+
978
+ # Gets the access control policy for a Table resource. Returns an empty policy
979
+ # if the resource exists but does not have a policy set.
980
+ # @param [String] resource
981
+ # REQUIRED: The resource for which the policy is being requested. See the
982
+ # operation documentation for the appropriate value for this field.
983
+ # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object
984
+ # @param [String] fields
985
+ # Selector specifying which fields to include in a partial response.
986
+ # @param [String] quota_user
987
+ # Available to use for quota purposes for server-side applications. Can be any
988
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
989
+ # @param [Google::Apis::RequestOptions] options
990
+ # Request-specific options
991
+ #
992
+ # @yield [result, err] Result & error if block supplied
993
+ # @yieldparam result [Google::Apis::BigtableadminV2::Policy] parsed result object
994
+ # @yieldparam err [StandardError] error object if request failed
995
+ #
996
+ # @return [Google::Apis::BigtableadminV2::Policy]
997
+ #
998
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
999
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1000
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1001
+ def get_backup_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1002
+ command = make_simple_command(:post, 'v2/{+resource}:getIamPolicy', options)
1003
+ command.request_representation = Google::Apis::BigtableadminV2::GetIamPolicyRequest::Representation
1004
+ command.request_object = get_iam_policy_request_object
1005
+ command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation
1006
+ command.response_class = Google::Apis::BigtableadminV2::Policy
1007
+ command.params['resource'] = resource unless resource.nil?
1008
+ command.query['fields'] = fields unless fields.nil?
1009
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1010
+ execute_or_queue_command(command, &block)
1011
+ end
1012
+
1013
+ # Lists Cloud Bigtable backups. Returns both completed and pending backups.
1014
+ # @param [String] parent
1015
+ # Required. The cluster to list backups from. Values are of the form `projects/`
1016
+ # project`/instances/`instance`/clusters/`cluster``. Use ``cluster` = '-'` to
1017
+ # list backups for all clusters in an instance, e.g., `projects/`project`/
1018
+ # instances/`instance`/clusters/-`.
1019
+ # @param [String] filter
1020
+ # A filter expression that filters backups listed in the response. The
1021
+ # expression must specify the field name, a comparison operator, and the value
1022
+ # that you want to use for filtering. The value must be a string, a number, or a
1023
+ # boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':'
1024
+ # represents a HAS operator which is roughly synonymous with equality. Filter
1025
+ # rules are case insensitive. The fields eligible for filtering are: * `name` * `
1026
+ # source_table` * `state` * `start_time` (and values are of the format YYYY-MM-
1027
+ # DDTHH:MM:SSZ) * `end_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ)
1028
+ # * `expire_time` (and values are of the format YYYY-MM-DDTHH:MM:SSZ) * `
1029
+ # size_bytes` To filter on multiple expressions, provide each separate
1030
+ # expression within parentheses. By default, each expression is an AND
1031
+ # expression. However, you can include AND, OR, and NOT expressions explicitly.
1032
+ # Some examples of using filters are: * `name:"exact"` --> The backup's name is
1033
+ # the string "exact". * `name:howl` --> The backup's name contains the string "
1034
+ # howl". * `source_table:prod` --> The source_table's name contains the string "
1035
+ # prod". * `state:CREATING` --> The backup is pending creation. * `state:READY` -
1036
+ # -> The backup is fully created and ready for use. * `(name:howl) AND (
1037
+ # start_time < \"2018-03-28T14:50:00Z\")` --> The backup name contains the
1038
+ # string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z. * `
1039
+ # size_bytes > 10000000000` --> The backup's size is greater than 10GB
1040
+ # @param [String] order_by
1041
+ # An expression for specifying the sort order of the results of the request. The
1042
+ # string value should specify one or more fields in Backup. The full syntax is
1043
+ # described at https://aip.dev/132#ordering. Fields supported are: * name *
1044
+ # source_table * expire_time * start_time * end_time * size_bytes * state For
1045
+ # example, "start_time". The default sorting order is ascending. To specify
1046
+ # descending order for the field, a suffix " desc" should be appended to the
1047
+ # field name. For example, "start_time desc". Redundant space characters in the
1048
+ # syntax are insigificant. If order_by is empty, results will be sorted by `
1049
+ # start_time` in descending order starting from the most recently created backup.
1050
+ # @param [Fixnum] page_size
1051
+ # Number of backups to be returned in the response. If 0 or less, defaults to
1052
+ # the server's maximum allowed page size.
1053
+ # @param [String] page_token
1054
+ # If non-empty, `page_token` should contain a next_page_token from a previous
1055
+ # ListBackupsResponse to the same `parent` and with the same `filter`.
1056
+ # @param [String] fields
1057
+ # Selector specifying which fields to include in a partial response.
1058
+ # @param [String] quota_user
1059
+ # Available to use for quota purposes for server-side applications. Can be any
1060
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1061
+ # @param [Google::Apis::RequestOptions] options
1062
+ # Request-specific options
1063
+ #
1064
+ # @yield [result, err] Result & error if block supplied
1065
+ # @yieldparam result [Google::Apis::BigtableadminV2::ListBackupsResponse] parsed result object
1066
+ # @yieldparam err [StandardError] error object if request failed
1067
+ #
1068
+ # @return [Google::Apis::BigtableadminV2::ListBackupsResponse]
1069
+ #
1070
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1071
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1072
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1073
+ def list_project_instance_cluster_backups(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1074
+ command = make_simple_command(:get, 'v2/{+parent}/backups', options)
1075
+ command.response_representation = Google::Apis::BigtableadminV2::ListBackupsResponse::Representation
1076
+ command.response_class = Google::Apis::BigtableadminV2::ListBackupsResponse
1077
+ command.params['parent'] = parent unless parent.nil?
1078
+ command.query['filter'] = filter unless filter.nil?
1079
+ command.query['orderBy'] = order_by unless order_by.nil?
1080
+ command.query['pageSize'] = page_size unless page_size.nil?
1081
+ command.query['pageToken'] = page_token unless page_token.nil?
1082
+ command.query['fields'] = fields unless fields.nil?
1083
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1084
+ execute_or_queue_command(command, &block)
1085
+ end
1086
+
1087
+ # Updates a pending or completed Cloud Bigtable Backup.
1088
+ # @param [String] name
1089
+ # A globally unique identifier for the backup which cannot be changed. Values
1090
+ # are of the form `projects/`project`/instances/`instance`/clusters/`cluster`/
1091
+ # backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50
1092
+ # characters in length. The backup is stored in the cluster identified by the
1093
+ # prefix of the backup name of the form `projects/`project`/instances/`instance`/
1094
+ # clusters/`cluster``.
1095
+ # @param [Google::Apis::BigtableadminV2::Backup] backup_object
1096
+ # @param [String] update_mask
1097
+ # Required. A mask specifying which fields (e.g. `expire_time`) in the Backup
1098
+ # resource should be updated. This mask is relative to the Backup resource, not
1099
+ # to the request message. The field mask must always be specified; this prevents
1100
+ # any future fields from being erased accidentally by clients that do not know
1101
+ # about them.
1102
+ # @param [String] fields
1103
+ # Selector specifying which fields to include in a partial response.
1104
+ # @param [String] quota_user
1105
+ # Available to use for quota purposes for server-side applications. Can be any
1106
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1107
+ # @param [Google::Apis::RequestOptions] options
1108
+ # Request-specific options
1109
+ #
1110
+ # @yield [result, err] Result & error if block supplied
1111
+ # @yieldparam result [Google::Apis::BigtableadminV2::Backup] parsed result object
1112
+ # @yieldparam err [StandardError] error object if request failed
1113
+ #
1114
+ # @return [Google::Apis::BigtableadminV2::Backup]
1115
+ #
1116
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1117
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1118
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1119
+ def patch_project_instance_cluster_backup(name, backup_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
1120
+ command = make_simple_command(:patch, 'v2/{+name}', options)
1121
+ command.request_representation = Google::Apis::BigtableadminV2::Backup::Representation
1122
+ command.request_object = backup_object
1123
+ command.response_representation = Google::Apis::BigtableadminV2::Backup::Representation
1124
+ command.response_class = Google::Apis::BigtableadminV2::Backup
1125
+ command.params['name'] = name unless name.nil?
1126
+ command.query['updateMask'] = update_mask unless update_mask.nil?
1127
+ command.query['fields'] = fields unless fields.nil?
1128
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1129
+ execute_or_queue_command(command, &block)
1130
+ end
1131
+
1132
+ # Sets the access control policy on a Table resource. Replaces any existing
1133
+ # policy.
1134
+ # @param [String] resource
1135
+ # REQUIRED: The resource for which the policy is being specified. See the
1136
+ # operation documentation for the appropriate value for this field.
1137
+ # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object
1138
+ # @param [String] fields
1139
+ # Selector specifying which fields to include in a partial response.
1140
+ # @param [String] quota_user
1141
+ # Available to use for quota purposes for server-side applications. Can be any
1142
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1143
+ # @param [Google::Apis::RequestOptions] options
1144
+ # Request-specific options
1145
+ #
1146
+ # @yield [result, err] Result & error if block supplied
1147
+ # @yieldparam result [Google::Apis::BigtableadminV2::Policy] parsed result object
1148
+ # @yieldparam err [StandardError] error object if request failed
1149
+ #
1150
+ # @return [Google::Apis::BigtableadminV2::Policy]
1151
+ #
1152
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1153
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1154
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1155
+ def set_backup_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1156
+ command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', options)
1157
+ command.request_representation = Google::Apis::BigtableadminV2::SetIamPolicyRequest::Representation
1158
+ command.request_object = set_iam_policy_request_object
1159
+ command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation
1160
+ command.response_class = Google::Apis::BigtableadminV2::Policy
1161
+ command.params['resource'] = resource unless resource.nil?
1162
+ command.query['fields'] = fields unless fields.nil?
1163
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1164
+ execute_or_queue_command(command, &block)
1165
+ end
1166
+
1167
+ # Returns permissions that the caller has on the specified table resource.
1168
+ # @param [String] resource
1169
+ # REQUIRED: The resource for which the policy detail is being requested. See the
1170
+ # operation documentation for the appropriate value for this field.
1171
+ # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object
1172
+ # @param [String] fields
1173
+ # Selector specifying which fields to include in a partial response.
1174
+ # @param [String] quota_user
1175
+ # Available to use for quota purposes for server-side applications. Can be any
1176
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1177
+ # @param [Google::Apis::RequestOptions] options
1178
+ # Request-specific options
1179
+ #
1180
+ # @yield [result, err] Result & error if block supplied
1181
+ # @yieldparam result [Google::Apis::BigtableadminV2::TestIamPermissionsResponse] parsed result object
1182
+ # @yieldparam err [StandardError] error object if request failed
1183
+ #
1184
+ # @return [Google::Apis::BigtableadminV2::TestIamPermissionsResponse]
1185
+ #
1186
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1187
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1188
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1189
+ def test_backup_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1190
+ command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', options)
1191
+ command.request_representation = Google::Apis::BigtableadminV2::TestIamPermissionsRequest::Representation
1192
+ command.request_object = test_iam_permissions_request_object
1193
+ command.response_representation = Google::Apis::BigtableadminV2::TestIamPermissionsResponse::Representation
1194
+ command.response_class = Google::Apis::BigtableadminV2::TestIamPermissionsResponse
1195
+ command.params['resource'] = resource unless resource.nil?
1196
+ command.query['fields'] = fields unless fields.nil?
1197
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1198
+ execute_or_queue_command(command, &block)
1199
+ end
1200
+
1201
+ # Checks replication consistency based on a consistency token, that is, if
1202
+ # replication has caught up based on the conditions specified in the token and
1203
+ # the check request.
1204
+ # @param [String] name
1205
+ # Required. The unique name of the Table for which to check replication
1206
+ # consistency. Values are of the form `projects/`project`/instances/`instance`/
1207
+ # tables/`table``.
1208
+ # @param [Google::Apis::BigtableadminV2::CheckConsistencyRequest] check_consistency_request_object
1209
+ # @param [String] fields
1210
+ # Selector specifying which fields to include in a partial response.
1211
+ # @param [String] quota_user
1212
+ # Available to use for quota purposes for server-side applications. Can be any
1213
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1214
+ # @param [Google::Apis::RequestOptions] options
1215
+ # Request-specific options
1216
+ #
1217
+ # @yield [result, err] Result & error if block supplied
1218
+ # @yieldparam result [Google::Apis::BigtableadminV2::CheckConsistencyResponse] parsed result object
1219
+ # @yieldparam err [StandardError] error object if request failed
1220
+ #
1221
+ # @return [Google::Apis::BigtableadminV2::CheckConsistencyResponse]
1222
+ #
1223
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1224
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1225
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1226
+ def check_table_consistency(name, check_consistency_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1227
+ command = make_simple_command(:post, 'v2/{+name}:checkConsistency', options)
1228
+ command.request_representation = Google::Apis::BigtableadminV2::CheckConsistencyRequest::Representation
1229
+ command.request_object = check_consistency_request_object
1230
+ command.response_representation = Google::Apis::BigtableadminV2::CheckConsistencyResponse::Representation
1231
+ command.response_class = Google::Apis::BigtableadminV2::CheckConsistencyResponse
1232
+ command.params['name'] = name unless name.nil?
1233
+ command.query['fields'] = fields unless fields.nil?
1234
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1235
+ execute_or_queue_command(command, &block)
1236
+ end
1237
+
1238
+ # Creates a new table in the specified instance. The table can be created with a
1239
+ # full set of initial column families, specified in the request.
1240
+ # @param [String] parent
1241
+ # Required. The unique name of the instance in which to create the table. Values
1242
+ # are of the form `projects/`project`/instances/`instance``.
1243
+ # @param [Google::Apis::BigtableadminV2::CreateTableRequest] create_table_request_object
1244
+ # @param [String] fields
1245
+ # Selector specifying which fields to include in a partial response.
1246
+ # @param [String] quota_user
1247
+ # Available to use for quota purposes for server-side applications. Can be any
1248
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1249
+ # @param [Google::Apis::RequestOptions] options
1250
+ # Request-specific options
1251
+ #
1252
+ # @yield [result, err] Result & error if block supplied
1253
+ # @yieldparam result [Google::Apis::BigtableadminV2::Table] parsed result object
1254
+ # @yieldparam err [StandardError] error object if request failed
1255
+ #
1256
+ # @return [Google::Apis::BigtableadminV2::Table]
1257
+ #
1258
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1259
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1260
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1261
+ def create_table(parent, create_table_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1262
+ command = make_simple_command(:post, 'v2/{+parent}/tables', options)
1263
+ command.request_representation = Google::Apis::BigtableadminV2::CreateTableRequest::Representation
1264
+ command.request_object = create_table_request_object
1265
+ command.response_representation = Google::Apis::BigtableadminV2::Table::Representation
1266
+ command.response_class = Google::Apis::BigtableadminV2::Table
1267
+ command.params['parent'] = parent unless parent.nil?
1268
+ command.query['fields'] = fields unless fields.nil?
1269
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1270
+ execute_or_queue_command(command, &block)
1271
+ end
1272
+
1273
+ # Permanently deletes a specified table and all of its data.
1274
+ # @param [String] name
1275
+ # Required. The unique name of the table to be deleted. Values are of the form `
1276
+ # projects/`project`/instances/`instance`/tables/`table``.
1277
+ # @param [String] fields
1278
+ # Selector specifying which fields to include in a partial response.
1279
+ # @param [String] quota_user
1280
+ # Available to use for quota purposes for server-side applications. Can be any
1281
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1282
+ # @param [Google::Apis::RequestOptions] options
1283
+ # Request-specific options
1284
+ #
1285
+ # @yield [result, err] Result & error if block supplied
1286
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
1287
+ # @yieldparam err [StandardError] error object if request failed
1288
+ #
1289
+ # @return [Google::Apis::BigtableadminV2::Empty]
1290
+ #
1291
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1292
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1293
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1294
+ def delete_project_instance_table(name, fields: nil, quota_user: nil, options: nil, &block)
1295
+ command = make_simple_command(:delete, 'v2/{+name}', options)
1296
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
1297
+ command.response_class = Google::Apis::BigtableadminV2::Empty
1298
+ command.params['name'] = name unless name.nil?
1299
+ command.query['fields'] = fields unless fields.nil?
1300
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1301
+ execute_or_queue_command(command, &block)
1302
+ end
1303
+
1304
+ # Permanently drop/delete a row range from a specified table. The request can
1305
+ # specify whether to delete all rows in a table, or only those that match a
1306
+ # particular prefix.
1307
+ # @param [String] name
1308
+ # Required. The unique name of the table on which to drop a range of rows.
1309
+ # Values are of the form `projects/`project`/instances/`instance`/tables/`table``
1310
+ # .
1311
+ # @param [Google::Apis::BigtableadminV2::DropRowRangeRequest] drop_row_range_request_object
1312
+ # @param [String] fields
1313
+ # Selector specifying which fields to include in a partial response.
1314
+ # @param [String] quota_user
1315
+ # Available to use for quota purposes for server-side applications. Can be any
1316
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1317
+ # @param [Google::Apis::RequestOptions] options
1318
+ # Request-specific options
1319
+ #
1320
+ # @yield [result, err] Result & error if block supplied
1321
+ # @yieldparam result [Google::Apis::BigtableadminV2::Empty] parsed result object
1322
+ # @yieldparam err [StandardError] error object if request failed
1323
+ #
1324
+ # @return [Google::Apis::BigtableadminV2::Empty]
1325
+ #
1326
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1327
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1328
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1329
+ def drop_table_row_range(name, drop_row_range_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1330
+ command = make_simple_command(:post, 'v2/{+name}:dropRowRange', options)
1331
+ command.request_representation = Google::Apis::BigtableadminV2::DropRowRangeRequest::Representation
1332
+ command.request_object = drop_row_range_request_object
1333
+ command.response_representation = Google::Apis::BigtableadminV2::Empty::Representation
1334
+ command.response_class = Google::Apis::BigtableadminV2::Empty
1335
+ command.params['name'] = name unless name.nil?
1336
+ command.query['fields'] = fields unless fields.nil?
1337
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1338
+ execute_or_queue_command(command, &block)
1339
+ end
1340
+
1341
+ # Generates a consistency token for a Table, which can be used in
1342
+ # CheckConsistency to check whether mutations to the table that finished before
1343
+ # this call started have been replicated. The tokens will be available for 90
1344
+ # days.
1345
+ # @param [String] name
1346
+ # Required. The unique name of the Table for which to create a consistency token.
1347
+ # Values are of the form `projects/`project`/instances/`instance`/tables/`table`
1348
+ # `.
1349
+ # @param [Google::Apis::BigtableadminV2::GenerateConsistencyTokenRequest] generate_consistency_token_request_object
1350
+ # @param [String] fields
1351
+ # Selector specifying which fields to include in a partial response.
1352
+ # @param [String] quota_user
1353
+ # Available to use for quota purposes for server-side applications. Can be any
1354
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1355
+ # @param [Google::Apis::RequestOptions] options
1356
+ # Request-specific options
1357
+ #
1358
+ # @yield [result, err] Result & error if block supplied
1359
+ # @yieldparam result [Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse] parsed result object
1360
+ # @yieldparam err [StandardError] error object if request failed
1361
+ #
1362
+ # @return [Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse]
1363
+ #
1364
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1365
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1366
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1367
+ def generate_table_consistency_token(name, generate_consistency_token_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1368
+ command = make_simple_command(:post, 'v2/{+name}:generateConsistencyToken', options)
1369
+ command.request_representation = Google::Apis::BigtableadminV2::GenerateConsistencyTokenRequest::Representation
1370
+ command.request_object = generate_consistency_token_request_object
1371
+ command.response_representation = Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse::Representation
1372
+ command.response_class = Google::Apis::BigtableadminV2::GenerateConsistencyTokenResponse
1373
+ command.params['name'] = name unless name.nil?
1374
+ command.query['fields'] = fields unless fields.nil?
1375
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1376
+ execute_or_queue_command(command, &block)
1377
+ end
1378
+
1379
+ # Gets metadata information about the specified table.
1380
+ # @param [String] name
1381
+ # Required. The unique name of the requested table. Values are of the form `
1382
+ # projects/`project`/instances/`instance`/tables/`table``.
1383
+ # @param [String] view
1384
+ # The view to be applied to the returned table's fields. Defaults to `
1385
+ # SCHEMA_VIEW` if unspecified.
1386
+ # @param [String] fields
1387
+ # Selector specifying which fields to include in a partial response.
1388
+ # @param [String] quota_user
1389
+ # Available to use for quota purposes for server-side applications. Can be any
1390
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1391
+ # @param [Google::Apis::RequestOptions] options
1392
+ # Request-specific options
1393
+ #
1394
+ # @yield [result, err] Result & error if block supplied
1395
+ # @yieldparam result [Google::Apis::BigtableadminV2::Table] parsed result object
1396
+ # @yieldparam err [StandardError] error object if request failed
1397
+ #
1398
+ # @return [Google::Apis::BigtableadminV2::Table]
1399
+ #
1400
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1401
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1402
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1403
+ def get_project_instance_table(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1404
+ command = make_simple_command(:get, 'v2/{+name}', options)
1405
+ command.response_representation = Google::Apis::BigtableadminV2::Table::Representation
1406
+ command.response_class = Google::Apis::BigtableadminV2::Table
1407
+ command.params['name'] = name unless name.nil?
1408
+ command.query['view'] = view unless view.nil?
1409
+ command.query['fields'] = fields unless fields.nil?
1410
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1411
+ execute_or_queue_command(command, &block)
1412
+ end
1413
+
1414
+ # Gets the access control policy for a Table resource. Returns an empty policy
1415
+ # if the resource exists but does not have a policy set.
1416
+ # @param [String] resource
1417
+ # REQUIRED: The resource for which the policy is being requested. See the
1418
+ # operation documentation for the appropriate value for this field.
1419
+ # @param [Google::Apis::BigtableadminV2::GetIamPolicyRequest] get_iam_policy_request_object
1420
+ # @param [String] fields
1421
+ # Selector specifying which fields to include in a partial response.
1422
+ # @param [String] quota_user
1423
+ # Available to use for quota purposes for server-side applications. Can be any
1424
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1425
+ # @param [Google::Apis::RequestOptions] options
1426
+ # Request-specific options
1427
+ #
1428
+ # @yield [result, err] Result & error if block supplied
1429
+ # @yieldparam result [Google::Apis::BigtableadminV2::Policy] parsed result object
1430
+ # @yieldparam err [StandardError] error object if request failed
1431
+ #
1432
+ # @return [Google::Apis::BigtableadminV2::Policy]
1433
+ #
1434
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1435
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1436
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1437
+ def get_table_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1438
+ command = make_simple_command(:post, 'v2/{+resource}:getIamPolicy', options)
1439
+ command.request_representation = Google::Apis::BigtableadminV2::GetIamPolicyRequest::Representation
1440
+ command.request_object = get_iam_policy_request_object
1441
+ command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation
1442
+ command.response_class = Google::Apis::BigtableadminV2::Policy
1443
+ command.params['resource'] = resource unless resource.nil?
1444
+ command.query['fields'] = fields unless fields.nil?
1445
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1446
+ execute_or_queue_command(command, &block)
1447
+ end
1448
+
1449
+ # Lists all tables served from a specified instance.
1450
+ # @param [String] parent
1451
+ # Required. The unique name of the instance for which tables should be listed.
1452
+ # Values are of the form `projects/`project`/instances/`instance``.
1453
+ # @param [Fixnum] page_size
1454
+ # Maximum number of results per page. A page_size of zero lets the server choose
1455
+ # the number of items to return. A page_size which is strictly positive will
1456
+ # return at most that many items. A negative page_size will cause an error.
1457
+ # Following the first request, subsequent paginated calls are not required to
1458
+ # pass a page_size. If a page_size is set in subsequent calls, it must match the
1459
+ # page_size given in the first request.
1460
+ # @param [String] page_token
1461
+ # The value of `next_page_token` returned by a previous call.
1462
+ # @param [String] view
1463
+ # The view to be applied to the returned tables' fields. Only NAME_ONLY view (
1464
+ # default) and REPLICATION_VIEW are supported.
1465
+ # @param [String] fields
1466
+ # Selector specifying which fields to include in a partial response.
1467
+ # @param [String] quota_user
1468
+ # Available to use for quota purposes for server-side applications. Can be any
1469
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1470
+ # @param [Google::Apis::RequestOptions] options
1471
+ # Request-specific options
1472
+ #
1473
+ # @yield [result, err] Result & error if block supplied
1474
+ # @yieldparam result [Google::Apis::BigtableadminV2::ListTablesResponse] parsed result object
1475
+ # @yieldparam err [StandardError] error object if request failed
1476
+ #
1477
+ # @return [Google::Apis::BigtableadminV2::ListTablesResponse]
1478
+ #
1479
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1480
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1481
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1482
+ def list_project_instance_tables(parent, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
1483
+ command = make_simple_command(:get, 'v2/{+parent}/tables', options)
1484
+ command.response_representation = Google::Apis::BigtableadminV2::ListTablesResponse::Representation
1485
+ command.response_class = Google::Apis::BigtableadminV2::ListTablesResponse
1486
+ command.params['parent'] = parent unless parent.nil?
1487
+ command.query['pageSize'] = page_size unless page_size.nil?
1488
+ command.query['pageToken'] = page_token unless page_token.nil?
1489
+ command.query['view'] = view unless view.nil?
1490
+ command.query['fields'] = fields unless fields.nil?
1491
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1492
+ execute_or_queue_command(command, &block)
1493
+ end
1494
+
1495
+ # Performs a series of column family modifications on the specified table.
1496
+ # Either all or none of the modifications will occur before this method returns,
1497
+ # but data requests received prior to that point may see a table where only some
1498
+ # modifications have taken effect.
1499
+ # @param [String] name
1500
+ # Required. The unique name of the table whose families should be modified.
1501
+ # Values are of the form `projects/`project`/instances/`instance`/tables/`table``
1502
+ # .
1503
+ # @param [Google::Apis::BigtableadminV2::ModifyColumnFamiliesRequest] modify_column_families_request_object
1504
+ # @param [String] fields
1505
+ # Selector specifying which fields to include in a partial response.
1506
+ # @param [String] quota_user
1507
+ # Available to use for quota purposes for server-side applications. Can be any
1508
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1509
+ # @param [Google::Apis::RequestOptions] options
1510
+ # Request-specific options
1511
+ #
1512
+ # @yield [result, err] Result & error if block supplied
1513
+ # @yieldparam result [Google::Apis::BigtableadminV2::Table] parsed result object
1514
+ # @yieldparam err [StandardError] error object if request failed
1515
+ #
1516
+ # @return [Google::Apis::BigtableadminV2::Table]
1517
+ #
1518
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1519
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1520
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1521
+ def modify_table_column_families(name, modify_column_families_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1522
+ command = make_simple_command(:post, 'v2/{+name}:modifyColumnFamilies', options)
1523
+ command.request_representation = Google::Apis::BigtableadminV2::ModifyColumnFamiliesRequest::Representation
1524
+ command.request_object = modify_column_families_request_object
1525
+ command.response_representation = Google::Apis::BigtableadminV2::Table::Representation
1526
+ command.response_class = Google::Apis::BigtableadminV2::Table
1527
+ command.params['name'] = name unless name.nil?
1528
+ command.query['fields'] = fields unless fields.nil?
1529
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1530
+ execute_or_queue_command(command, &block)
1531
+ end
1532
+
1533
+ # Create a new table by restoring from a completed backup. The new table must be
1534
+ # in the same instance as the instance containing the backup. The returned table
1535
+ # long-running operation can be used to track the progress of the operation, and
1536
+ # to cancel it. The metadata field type is RestoreTableMetadata. The response
1537
+ # type is Table, if successful.
1538
+ # @param [String] parent
1539
+ # Required. The name of the instance in which to create the restored table. This
1540
+ # instance must be the parent of the source backup. Values are of the form `
1541
+ # projects//instances/`.
1542
+ # @param [Google::Apis::BigtableadminV2::RestoreTableRequest] restore_table_request_object
1543
+ # @param [String] fields
1544
+ # Selector specifying which fields to include in a partial response.
1545
+ # @param [String] quota_user
1546
+ # Available to use for quota purposes for server-side applications. Can be any
1547
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1548
+ # @param [Google::Apis::RequestOptions] options
1549
+ # Request-specific options
1550
+ #
1551
+ # @yield [result, err] Result & error if block supplied
1552
+ # @yieldparam result [Google::Apis::BigtableadminV2::Operation] parsed result object
1553
+ # @yieldparam err [StandardError] error object if request failed
1554
+ #
1555
+ # @return [Google::Apis::BigtableadminV2::Operation]
1556
+ #
1557
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1558
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1559
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1560
+ def restore_table(parent, restore_table_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1561
+ command = make_simple_command(:post, 'v2/{+parent}/tables:restore', options)
1562
+ command.request_representation = Google::Apis::BigtableadminV2::RestoreTableRequest::Representation
1563
+ command.request_object = restore_table_request_object
1564
+ command.response_representation = Google::Apis::BigtableadminV2::Operation::Representation
1565
+ command.response_class = Google::Apis::BigtableadminV2::Operation
1566
+ command.params['parent'] = parent unless parent.nil?
1567
+ command.query['fields'] = fields unless fields.nil?
1568
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1569
+ execute_or_queue_command(command, &block)
1570
+ end
1571
+
1572
+ # Sets the access control policy on a Table resource. Replaces any existing
1573
+ # policy.
1574
+ # @param [String] resource
1575
+ # REQUIRED: The resource for which the policy is being specified. See the
1576
+ # operation documentation for the appropriate value for this field.
1577
+ # @param [Google::Apis::BigtableadminV2::SetIamPolicyRequest] set_iam_policy_request_object
1578
+ # @param [String] fields
1579
+ # Selector specifying which fields to include in a partial response.
1580
+ # @param [String] quota_user
1581
+ # Available to use for quota purposes for server-side applications. Can be any
1582
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1583
+ # @param [Google::Apis::RequestOptions] options
1584
+ # Request-specific options
1585
+ #
1586
+ # @yield [result, err] Result & error if block supplied
1587
+ # @yieldparam result [Google::Apis::BigtableadminV2::Policy] parsed result object
1588
+ # @yieldparam err [StandardError] error object if request failed
1589
+ #
1590
+ # @return [Google::Apis::BigtableadminV2::Policy]
1591
+ #
1592
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1593
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1594
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1595
+ def set_table_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1596
+ command = make_simple_command(:post, 'v2/{+resource}:setIamPolicy', options)
1597
+ command.request_representation = Google::Apis::BigtableadminV2::SetIamPolicyRequest::Representation
1598
+ command.request_object = set_iam_policy_request_object
1599
+ command.response_representation = Google::Apis::BigtableadminV2::Policy::Representation
1600
+ command.response_class = Google::Apis::BigtableadminV2::Policy
1601
+ command.params['resource'] = resource unless resource.nil?
1602
+ command.query['fields'] = fields unless fields.nil?
1603
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1604
+ execute_or_queue_command(command, &block)
1605
+ end
1606
+
1607
+ # Returns permissions that the caller has on the specified table resource.
1608
+ # @param [String] resource
1609
+ # REQUIRED: The resource for which the policy detail is being requested. See the
1610
+ # operation documentation for the appropriate value for this field.
1611
+ # @param [Google::Apis::BigtableadminV2::TestIamPermissionsRequest] test_iam_permissions_request_object
1612
+ # @param [String] fields
1613
+ # Selector specifying which fields to include in a partial response.
1614
+ # @param [String] quota_user
1615
+ # Available to use for quota purposes for server-side applications. Can be any
1616
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1617
+ # @param [Google::Apis::RequestOptions] options
1618
+ # Request-specific options
1619
+ #
1620
+ # @yield [result, err] Result & error if block supplied
1621
+ # @yieldparam result [Google::Apis::BigtableadminV2::TestIamPermissionsResponse] parsed result object
1622
+ # @yieldparam err [StandardError] error object if request failed
1623
+ #
1624
+ # @return [Google::Apis::BigtableadminV2::TestIamPermissionsResponse]
1625
+ #
1626
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1627
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1628
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1629
+ def test_table_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
1630
+ command = make_simple_command(:post, 'v2/{+resource}:testIamPermissions', options)
1631
+ command.request_representation = Google::Apis::BigtableadminV2::TestIamPermissionsRequest::Representation
1632
+ command.request_object = test_iam_permissions_request_object
1633
+ command.response_representation = Google::Apis::BigtableadminV2::TestIamPermissionsResponse::Representation
1634
+ command.response_class = Google::Apis::BigtableadminV2::TestIamPermissionsResponse
1635
+ command.params['resource'] = resource unless resource.nil?
1636
+ command.query['fields'] = fields unless fields.nil?
1637
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1638
+ execute_or_queue_command(command, &block)
1639
+ end
1640
+
1641
+ # Gets information about a location.
1642
+ # @param [String] name
1643
+ # Resource name for the location.
1644
+ # @param [String] fields
1645
+ # Selector specifying which fields to include in a partial response.
1646
+ # @param [String] quota_user
1647
+ # Available to use for quota purposes for server-side applications. Can be any
1648
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1649
+ # @param [Google::Apis::RequestOptions] options
1650
+ # Request-specific options
1651
+ #
1652
+ # @yield [result, err] Result & error if block supplied
1653
+ # @yieldparam result [Google::Apis::BigtableadminV2::Location] parsed result object
1654
+ # @yieldparam err [StandardError] error object if request failed
1655
+ #
1656
+ # @return [Google::Apis::BigtableadminV2::Location]
1657
+ #
1658
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1659
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1660
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1661
+ def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
1662
+ command = make_simple_command(:get, 'v2/{+name}', options)
1663
+ command.response_representation = Google::Apis::BigtableadminV2::Location::Representation
1664
+ command.response_class = Google::Apis::BigtableadminV2::Location
1665
+ command.params['name'] = name unless name.nil?
1666
+ command.query['fields'] = fields unless fields.nil?
1667
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1668
+ execute_or_queue_command(command, &block)
1669
+ end
1670
+
1671
+ # Lists information about the supported locations for this service.
1672
+ # @param [String] name
1673
+ # The resource that owns the locations collection, if applicable.
1674
+ # @param [String] filter
1675
+ # The standard list filter.
1676
+ # @param [Fixnum] page_size
1677
+ # The standard list page size.
1678
+ # @param [String] page_token
1679
+ # The standard list page token.
1680
+ # @param [String] fields
1681
+ # Selector specifying which fields to include in a partial response.
1682
+ # @param [String] quota_user
1683
+ # Available to use for quota purposes for server-side applications. Can be any
1684
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1685
+ # @param [Google::Apis::RequestOptions] options
1686
+ # Request-specific options
1687
+ #
1688
+ # @yield [result, err] Result & error if block supplied
1689
+ # @yieldparam result [Google::Apis::BigtableadminV2::ListLocationsResponse] parsed result object
1690
+ # @yieldparam err [StandardError] error object if request failed
1691
+ #
1692
+ # @return [Google::Apis::BigtableadminV2::ListLocationsResponse]
1693
+ #
1694
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1695
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1696
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1697
+ def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
1698
+ command = make_simple_command(:get, 'v2/{+name}/locations', options)
1699
+ command.response_representation = Google::Apis::BigtableadminV2::ListLocationsResponse::Representation
1700
+ command.response_class = Google::Apis::BigtableadminV2::ListLocationsResponse
1701
+ command.params['name'] = name unless name.nil?
1702
+ command.query['filter'] = filter unless filter.nil?
1703
+ command.query['pageSize'] = page_size unless page_size.nil?
1704
+ command.query['pageToken'] = page_token unless page_token.nil?
1705
+ command.query['fields'] = fields unless fields.nil?
1706
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1707
+ execute_or_queue_command(command, &block)
1708
+ end
1709
+
1710
+ protected
1711
+
1712
+ def apply_command_defaults(command)
1713
+ command.query['key'] = key unless key.nil?
1714
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1715
+ end
1716
+ end
1717
+ end
1718
+ end
1719
+ end