Class: Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb

Overview

Service for creating, configuring, and deleting Cloud Bigtable tables.

Provides access to the table schemas only, not the data stored within the tables.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"bigtableadmin.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/bigtable.admin",
  "https://www.googleapis.com/auth/bigtable.admin.cluster",
  "https://www.googleapis.com/auth/bigtable.admin.instance",
  "https://www.googleapis.com/auth/bigtable.admin.table",
  "https://www.googleapis.com/auth/cloud-bigtable.admin",
  "https://www.googleapis.com/auth/cloud-bigtable.admin.cluster",
  "https://www.googleapis.com/auth/cloud-bigtable.admin.table",
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/cloud-platform.read-only"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ BigtableTableAdminClient

Returns a new instance of BigtableTableAdminClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • service_address (String) (defaults to: nil) —

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil) —

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 204

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/bigtable/admin/v2/bigtable_table_admin_services_pb"

  credentials ||= Google::Cloud::Bigtable::Admin::V2::Credentials.default

  @operations_client = OperationsClient.new(
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    lib_name: lib_name,
    service_address: service_address,
    service_port: service_port,
    lib_version: lib_version,
    metadata: metadata,
  )

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Bigtable::Admin::V2::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Bigtable::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "bigtable_table_admin_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.bigtable.admin.v2.BigtableTableAdmin",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @bigtable_table_admin_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Bigtable::Admin::V2::BigtableTableAdmin::Stub.method(:new)
  )

  @create_table = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:create_table),
    defaults["create_table"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @create_table_from_snapshot = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:create_table_from_snapshot),
    defaults["create_table_from_snapshot"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @list_tables = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:list_tables),
    defaults["list_tables"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_table = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:get_table),
    defaults["get_table"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @delete_table = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:delete_table),
    defaults["delete_table"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @modify_column_families = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:modify_column_families),
    defaults["modify_column_families"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @drop_row_range = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:drop_row_range),
    defaults["drop_row_range"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @generate_consistency_token = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:generate_consistency_token),
    defaults["generate_consistency_token"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @check_consistency = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:check_consistency),
    defaults["check_consistency"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:get_iam_policy),
    defaults["get_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @set_iam_policy = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:set_iam_policy),
    defaults["set_iam_policy"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @test_iam_permissions = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
  @snapshot_table = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:snapshot_table),
    defaults["snapshot_table"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_snapshot = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:get_snapshot),
    defaults["get_snapshot"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_snapshots = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:list_snapshots),
    defaults["list_snapshots"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @delete_snapshot = Google::Gax.create_api_call(
    @bigtable_table_admin_stub.method(:delete_snapshot),
    defaults["delete_snapshot"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
end

Class Method Details

.cluster_path(project, instance, cluster) ⇒ String

Returns a fully-qualified cluster resource name string.

Parameters:

  • project (String)
  • instance (String)
  • cluster (String)

Returns:

  • (String) 


124
125
126
127
128
129
130
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 124

def self.cluster_path project, instance, cluster
  CLUSTER_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance,
    :"cluster" => cluster
  )
end

.instance_path(project, instance) ⇒ String

Returns a fully-qualified instance resource name string.

Parameters:

  • project (String)
  • instance (String)

Returns:

  • (String) 


136
137
138
139
140
141
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 136

def self.instance_path project, instance
  INSTANCE_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance
  )
end

.snapshot_path(project, instance, cluster, snapshot) ⇒ String

Returns a fully-qualified snapshot resource name string.

Parameters:

  • project (String)
  • instance (String)
  • cluster (String)
  • snapshot (String)

Returns:

  • (String) 


149
150
151
152
153
154
155
156
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 149

def self.snapshot_path project, instance, cluster, snapshot
  SNAPSHOT_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance,
    :"cluster" => cluster,
    :"snapshot" => snapshot
  )
end

.table_path(project, instance, table) ⇒ String

Returns a fully-qualified table resource name string.

Parameters:

  • project (String)
  • instance (String)
  • table (String)

Returns:

  • (String) 


163
164
165
166
167
168
169
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 163

def self.table_path project, instance, table
  TABLE_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance,
    :"table" => table
  )
end

Instance Method Details

#check_consistency(name, consistency_token, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::CheckConsistencyResponse

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")

# TODO: Initialize `consistency_token`:
consistency_token = ''
response = bigtable_table_admin_client.check_consistency(formatted_name, consistency_token)

Parameters:

  • name (String) —

    The unique name of the Table for which to check replication consistency. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

  • consistency_token (String) —

    The token created using GenerateConsistencyToken for the Table.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 860

def check_consistency \
    name,
    consistency_token,
    options: nil,
    &block
  req = {
    name: name,
    consistency_token: consistency_token
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::CheckConsistencyRequest)
  @check_consistency.call(req, options, &block)
end

#create_table(parent, table_id, table, initial_splits: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::Table

Creates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize `table_id`:
table_id = ''

# TODO: Initialize `table`:
table = {}
response = bigtable_table_admin_client.create_table(formatted_parent, table_id, table)

Parameters:

  • parent (String) —

    The unique name of the instance in which to create the table. Values are of the form projects/<project>/instances/<instance>.

  • table_id (String) —

    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than <parent>/tables/foobar.

  • table (Google::Bigtable::Admin::V2::Table | Hash) —

    The Table to create. A hash of the same form as Google::Bigtable::Admin::V2::Table can also be provided.

  • initial_splits (Array<Google::Bigtable::Admin::V2::CreateTableRequest::Split | Hash>) (defaults to: nil) —

    The optional list of row keys that will be used to initially split the table into several tablets (tablets are similar to HBase regions). Given two split keys, s1 and s2, three tablets will be created, spanning the key ranges: [, s1), [s1, s2), [s2, ).

    Example:

    • Row keys := ["a", "apple", "custom", "customer_1", "customer_2", "other", "zz"]
    • initial_split_keys := ["apple", "customer_1", "customer_2", "other"]
    • Key assignment:
      • Tablet 1 [, apple) => {"a"}.
      • Tablet 2 [apple, customer_1) => {"apple", "custom"}.
      • Tablet 3 [customer_1, customer_2) => {"customer_1"}.
      • Tablet 4 [customer_2, other) => {"customer_2"}.
      • Tablet 5 [other, ) => {"other", "zz"}. A hash of the same form as Google::Bigtable::Admin::V2::CreateTableRequest::Split can also be provided.
  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 478

def create_table \
    parent,
    table_id,
    table,
    initial_splits: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    table_id: table_id,
    table: table,
    initial_splits: initial_splits
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::CreateTableRequest)
  @create_table.call(req, options, &block)
end

#create_table_from_snapshot(parent, table_id, source_snapshot, options: nil) ⇒ Google::Gax::Operation

Creates a new table from the specified snapshot. The target table must not exist. The snapshot and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize `table_id`:
table_id = ''

# TODO: Initialize `source_snapshot`:
source_snapshot = ''

# Register a callback during the method call.
operation = bigtable_table_admin_client.create_table_from_snapshot(formatted_parent, table_id, source_snapshot) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • parent (String) —

    The unique name of the instance in which to create the table. Values are of the form projects/<project>/instances/<instance>.

  • table_id (String) —

    The name by which the new table should be referred to within the parent instance, e.g., foobar rather than <parent>/tables/foobar.

  • source_snapshot (String) —

    The unique name of the snapshot from which to restore the table. The snapshot and the table must be in the same instance. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 559

def create_table_from_snapshot \
    parent,
    table_id,
    source_snapshot,
    options: nil
  req = {
    parent: parent,
    table_id: table_id,
    source_snapshot: source_snapshot
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::CreateTableFromSnapshotRequest)
  operation = Google::Gax::Operation.new(
    @create_table_from_snapshot.call(req, options),
    @operations_client,
    Google::Bigtable::Admin::V2::Table,
    Google::Bigtable::Admin::V2::CreateTableFromSnapshotMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#delete_snapshot(name, options: nil) {|result, operation| ... } ⇒ Object

Permanently deletes the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.snapshot_path("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]")
bigtable_table_admin_client.delete_snapshot(formatted_name)

Parameters:

  • name (String) —

    The unique name of the snapshot to be deleted. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 1229

def delete_snapshot \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::DeleteSnapshotRequest)
  @delete_snapshot.call(req, options, &block)
  nil
end

#delete_table(name, options: nil) {|result, operation| ... } ⇒ Object

Permanently deletes a specified table and all of its data.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
bigtable_table_admin_client.delete_table(formatted_name)

Parameters:

  • name (String) —

    The unique name of the table to be deleted. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 695

def delete_table \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::DeleteTableRequest)
  @delete_table.call(req, options, &block)
  nil
end

#drop_row_range(name, row_key_prefix: nil, delete_all_data_from_table: nil, options: nil) {|result, operation| ... } ⇒ Object

Permanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular prefix.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
bigtable_table_admin_client.drop_row_range(formatted_name)

Parameters:

  • name (String) —

    The unique name of the table on which to drop a range of rows. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

  • row_key_prefix (String) (defaults to: nil) —

    Delete all rows that start with this row key prefix. Prefix cannot be zero length.

  • delete_all_data_from_table (true, false) (defaults to: nil) —

    Delete all rows in the table. Setting this to false is a no-op.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 781

def drop_row_range \
    name,
    row_key_prefix: nil,
    delete_all_data_from_table: nil,
    options: nil,
    &block
  req = {
    name: name,
    row_key_prefix: row_key_prefix,
    delete_all_data_from_table: delete_all_data_from_table
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::DropRowRangeRequest)
  @drop_row_range.call(req, options, &block)
  nil
end

#generate_consistency_token(name, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::GenerateConsistencyTokenResponse

Generates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started have been replicated. The tokens will be available for 90 days.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
response = bigtable_table_admin_client.generate_consistency_token(formatted_name)

Parameters:

  • name (String) —

    The unique name of the Table for which to create a consistency token. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



821
822
823
824
825
826
827
828
829
830
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 821

def generate_consistency_token \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::GenerateConsistencyTokenRequest)
  @generate_consistency_token.call(req, options, &block)
end

#get_iam_policy(resource, options_: nil, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Gets the access control policy for a table resource. Returns an empty policy if an table exists but does not have a policy set.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
response = bigtable_table_admin_client.get_iam_policy(formatted_resource)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • options_ (Google::Iam::V1::GetPolicyOptions | Hash) (defaults to: nil) —

    OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM. A hash of the same form as Google::Iam::V1::GetPolicyOptions can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 899

def get_iam_policy \
    resource,
    options_: nil,
    options: nil,
    &block
  req = {
    resource: resource,
    options: options_
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::GetIamPolicyRequest)
  @get_iam_policy.call(req, options, &block)
end

#get_snapshot(name, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::Snapshot

Gets metadata information about the specified snapshot.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.snapshot_path("[PROJECT]", "[INSTANCE]", "[CLUSTER]", "[SNAPSHOT]")
response = bigtable_table_admin_client.get_snapshot(formatted_name)

Parameters:

  • name (String) —

    The unique name of the requested snapshot. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 1128

def get_snapshot \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::GetSnapshotRequest)
  @get_snapshot.call(req, options, &block)
end

#get_table(name, view: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::Table

Gets metadata information about the specified table.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")
response = bigtable_table_admin_client.get_table(formatted_name)

Parameters:

  • name (String) —

    The unique name of the requested table. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

  • view (Google::Bigtable::Admin::V2::Table::View) (defaults to: nil) —

    The view to be applied to the returned table's fields. Defaults to SCHEMA_VIEW if unspecified.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



662
663
664
665
666
667
668
669
670
671
672
673
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 662

def get_table \
    name,
    view: nil,
    options: nil,
    &block
  req = {
    name: name,
    view: view
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::GetTableRequest)
  @get_table.call(req, options, &block)
end

#list_snapshots(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Snapshot>

Lists all snapshots associated with the specified cluster.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.cluster_path("[PROJECT]", "[INSTANCE]", "[CLUSTER]")

# Iterate over all results.
bigtable_table_admin_client.list_snapshots(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
bigtable_table_admin_client.list_snapshots(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    The unique name of the cluster for which snapshots should be listed. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>. Use <cluster> = '-' to list snapshots for all clusters in an instance, e.g., projects/<project>/instances/<instance>/clusters/-.

  • page_size (Integer) (defaults to: nil) —

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Snapshot>) —

    An enumerable of Google::Bigtable::Admin::V2::Snapshot instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 1190

def list_snapshots \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::ListSnapshotsRequest)
  @list_snapshots.call(req, options, &block)
end

#list_tables(parent, view: nil, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Table>

Lists all tables served from a specified instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# Iterate over all results.
bigtable_table_admin_client.list_tables(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
bigtable_table_admin_client.list_tables(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String) —

    The unique name of the instance for which tables should be listed. Values are of the form projects/<project>/instances/<instance>.

  • view (Google::Bigtable::Admin::V2::Table::View) (defaults to: nil) —

    The view to be applied to the returned tables' fields. Defaults to NAME_ONLY if unspecified; no others are currently supported.

  • page_size (Integer) (defaults to: nil) —

    Maximum number of results per page. CURRENTLY UNIMPLEMENTED AND IGNORED.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Bigtable::Admin::V2::Table>) —

    An enumerable of Google::Bigtable::Admin::V2::Table instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



623
624
625
626
627
628
629
630
631
632
633
634
635
636
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 623

def list_tables \
    parent,
    view: nil,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    view: view,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::ListTablesRequest)
  @list_tables.call(req, options, &block)
end

#modify_column_families(name, modifications, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::Table

Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")

# TODO: Initialize `modifications`:
modifications = []
response = bigtable_table_admin_client.modify_column_families(formatted_name, modifications)

Parameters:

  • name (String) —

    The unique name of the table whose families should be modified. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

  • modifications (Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification | Hash>) —

    Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example). A hash of the same form as Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 741

def modify_column_families \
    name,
    modifications,
    options: nil,
    &block
  req = {
    name: name,
    modifications: modifications
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest)
  @modify_column_families.call(req, options, &block)
end

#set_iam_policy(resource, policy, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::Policy

Sets the access control policy on a table resource. Replaces any existing policy.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")

# TODO: Initialize `policy`:
policy = {}
response = bigtable_table_admin_client.set_iam_policy(formatted_resource, policy)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • policy (Google::Iam::V1::Policy | Hash) —

    REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. A hash of the same form as Google::Iam::V1::Policy can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 943

def set_iam_policy \
    resource,
    policy,
    options: nil,
    &block
  req = {
    resource: resource,
    policy: policy
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::SetIamPolicyRequest)
  @set_iam_policy.call(req, options, &block)
end

#snapshot_table(name, cluster, snapshot_id, description, ttl: nil, options: nil) ⇒ Google::Gax::Operation

Creates a new snapshot in the specified cluster from the specified source table. The cluster and the table must be in the same instance.

Note: This is a private alpha release of Cloud Bigtable snapshots. This feature is not currently available to most Cloud Bigtable customers. This feature might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")

# TODO: Initialize `cluster`:
cluster = ''

# TODO: Initialize `snapshot_id`:
snapshot_id = ''

# TODO: Initialize `description`:
description = ''

# Register a callback during the method call.
operation = bigtable_table_admin_client.snapshot_table(formatted_name, cluster, snapshot_id, description) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Parameters:

  • name (String) —

    The unique name of the table to have the snapshot taken. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

  • cluster (String) —

    The name of the cluster where the snapshot will be created in. Values are of the form projects/<project>/instances/<instance>/clusters/<cluster>.

  • snapshot_id (String) —

    The ID by which the new snapshot should be referred to within the parent cluster, e.g., mysnapshot of the form: [_a-zA-Z0-9][-_.a-zA-Z0-9]* rather than projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot.

  • description (String) —

    Description of the snapshot.

  • ttl (Google::Protobuf::Duration | Hash) (defaults to: nil) —

    The amount of time that the new snapshot can stay active after it is created. Once 'ttl' expires, the snapshot will get deleted. The maximum amount of time a snapshot can stay active is 7 days. If 'ttl' is not specified, the default value of 24 hours will be used. A hash of the same form as Google::Protobuf::Duration can also be provided.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 1075

def snapshot_table \
    name,
    cluster,
    snapshot_id,
    description,
    ttl: nil,
    options: nil
  req = {
    name: name,
    cluster: cluster,
    snapshot_id: snapshot_id,
    description: description,
    ttl: ttl
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::SnapshotTableRequest)
  operation = Google::Gax::Operation.new(
    @snapshot_table.call(req, options),
    @operations_client,
    Google::Bigtable::Admin::V2::Snapshot,
    Google::Bigtable::Admin::V2::SnapshotTableMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#test_iam_permissions(resource, permissions, options: nil) {|result, operation| ... } ⇒ Google::Iam::V1::TestIamPermissionsResponse

Returns permissions that the caller has on the specified table resource.

Examples:

require "google/cloud/bigtable/admin"

bigtable_table_admin_client = Google::Cloud::Bigtable::Admin::BigtableTableAdmin.new(version: :v2)
formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableTableAdminClient.table_path("[PROJECT]", "[INSTANCE]", "[TABLE]")

# TODO: Initialize `permissions`:
permissions = []
response = bigtable_table_admin_client.test_iam_permissions(formatted_resource, permissions)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • permissions (Array<String>) —

    The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb', line 984

def test_iam_permissions \
    resource,
    permissions,
    options: nil,
    &block
  req = {
    resource: resource,
    permissions: permissions
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Iam::V1::TestIamPermissionsRequest)
  @test_iam_permissions.call(req, options, &block)
end