Class: Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient

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

Overview

Service for creating, configuring, and deleting Cloud Bigtable Instances and Clusters. Provides access to the Instance and Cluster schemas only, not the tables' metadata or data stored in those tables.

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, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ BigtableInstanceAdminClient

Returns a new instance of BigtableInstanceAdminClient

Parameters:

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

    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>) —

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

  • client_config (Hash) —

    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) —

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

  • metadata (Hash) —

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

  • exception_transformer (Proc) —

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



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

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: 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_instance_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,
    lib_version: lib_version,
  )

  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 = Gem.loaded_specs['google-cloud-bigtable'].version.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_instance_admin_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.bigtable.admin.v2.BigtableInstanceAdmin",
      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 = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @bigtable_instance_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::BigtableInstanceAdmin::Stub.method(:new)
  )

  @create_instance = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:create_instance),
    defaults["create_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_instance = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:get_instance),
    defaults["get_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_instances = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:list_instances),
    defaults["list_instances"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_instance = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:update_instance),
    defaults["update_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @partial_update_instance = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:partial_update_instance),
    defaults["partial_update_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'instance.name' => request.instance.name}
    end
  )
  @delete_instance = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:delete_instance),
    defaults["delete_instance"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_cluster = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:create_cluster),
    defaults["create_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_cluster = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:get_cluster),
    defaults["get_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_clusters = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:list_clusters),
    defaults["list_clusters"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_cluster = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:update_cluster),
    defaults["update_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @delete_cluster = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:delete_cluster),
    defaults["delete_cluster"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @create_app_profile = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:create_app_profile),
    defaults["create_app_profile"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_app_profile = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:get_app_profile),
    defaults["get_app_profile"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @list_app_profiles = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:list_app_profiles),
    defaults["list_app_profiles"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_app_profile = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:update_app_profile),
    defaults["update_app_profile"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'app_profile.name' => request.app_profile.name}
    end
  )
  @delete_app_profile = Google::Gax.create_api_call(
    @bigtable_instance_admin_stub.method(:delete_app_profile),
    defaults["delete_app_profile"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @bigtable_instance_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_instance_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_instance_admin_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'resource' => request.resource}
    end
  )
end

Class Method Details

.app_profile_path(project, instance, app_profile) ⇒ String

Returns a fully-qualified app_profile resource name string.

Parameters:

  • project (String)
  • instance (String)
  • app_profile (String)

Returns:

  • (String) 


142
143
144
145
146
147
148
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 142

def self.app_profile_path project, instance, app_profile
  APP_PROFILE_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance,
    :"app_profile" => app_profile
  )
end

.cluster_path(project, instance, cluster) ⇒ String

Returns a fully-qualified cluster resource name string.

Parameters:

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

Returns:

  • (String) 


155
156
157
158
159
160
161
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 155

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) 


130
131
132
133
134
135
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 130

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

.location_path(project, location) ⇒ String

Returns a fully-qualified location resource name string.

Parameters:

  • project (String)
  • location (String)

Returns:

  • (String) 


167
168
169
170
171
172
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 167

def self.location_path project, location
  LOCATION_PATH_TEMPLATE.render(
    :"project" => project,
    :"location" => location
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


120
121
122
123
124
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 120

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

Instance Method Details

#create_app_profile(parent, app_profile_id, app_profile, ignore_warnings: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::AppProfile

Creates an app profile within an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize +app_profile_id+:
app_profile_id = ''

# TODO: Initialize +app_profile+:
app_profile = {}
response = bigtable_instance_admin_client.create_app_profile(formatted_parent, app_profile_id, app_profile)

Parameters:

  • parent (String) —

    The unique name of the instance in which to create the new app profile. Values are of the form +projects//instances/+.

  • app_profile_id (String) —

    The ID to be used when referring to the new app profile within its instance, e.g., just +myprofile+ rather than +projects/myproject/instances/myinstance/appProfiles/myprofile+.

  • app_profile (Google::Bigtable::Admin::V2::AppProfile | Hash) —

    The app profile to be created. Fields marked +OutputOnly+ will be ignored. A hash of the same form as Google::Bigtable::Admin::V2::AppProfile can also be provided.

  • ignore_warnings (true, false) —

    If true, ignore safety checks when creating the app profile.

  • options (Google::Gax::CallOptions) —

    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.



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1083

def create_app_profile \
    parent,
    app_profile_id,
    app_profile,
    ignore_warnings: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    app_profile_id: app_profile_id,
    app_profile: app_profile,
    ignore_warnings: ignore_warnings
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::CreateAppProfileRequest)
  @create_app_profile.call(req, options, &block)
end

#create_cluster(parent, cluster_id, cluster, options: nil) ⇒ Google::Gax::Operation

Creates a cluster within an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize +cluster_id+:
cluster_id = ''

# TODO: Initialize +cluster+:
cluster = {}

# Register a callback during the method call.
operation = bigtable_instance_admin_client.create_cluster(formatted_parent, cluster_id, cluster) 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 new cluster. Values are of the form +projects//instances/+.

  • cluster_id (String) —

    The ID to be used when referring to the new cluster within its instance, e.g., just +mycluster+ rather than +projects/myproject/instances/myinstance/clusters/mycluster+.

  • cluster (Google::Bigtable::Admin::V2::Cluster | Hash) —

    The cluster to be created. Fields marked +OutputOnly+ must be left blank. A hash of the same form as Google::Bigtable::Admin::V2::Cluster can also be provided.

  • options (Google::Gax::CallOptions) —

    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.



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 835

def create_cluster \
    parent,
    cluster_id,
    cluster,
    options: nil
  req = {
    parent: parent,
    cluster_id: cluster_id,
    cluster: cluster
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::CreateClusterRequest)
  operation = Google::Gax::Operation.new(
    @create_cluster.call(req, options),
    @operations_client,
    Google::Bigtable::Admin::V2::Cluster,
    Google::Bigtable::Admin::V2::CreateClusterMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#create_instance(parent, instance_id, instance, clusters, options: nil) ⇒ Google::Gax::Operation

Create an instance within a project.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.project_path("[PROJECT]")

# TODO: Initialize +instance_id+:
instance_id = ''

# TODO: Initialize +instance+:
instance = {}

# TODO: Initialize +clusters+:
clusters = {}

# Register a callback during the method call.
operation = bigtable_instance_admin_client.create_instance(formatted_parent, instance_id, instance, clusters) 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 project in which to create the new instance. Values are of the form +projects/+.

  • instance_id (String) —

    The ID to be used when referring to the new instance within its project, e.g., just +myinstance+ rather than +projects/myproject/instances/myinstance+.

  • instance (Google::Bigtable::Admin::V2::Instance | Hash) —

    The instance to create. Fields marked +OutputOnly+ must be left blank. A hash of the same form as Google::Bigtable::Admin::V2::Instance can also be provided.

  • clusters (Hash{String => Google::Bigtable::Admin::V2::Cluster | Hash}) —

    The clusters to be created within the instance, mapped by desired cluster ID, e.g., just +mycluster+ rather than +projects/myproject/instances/myinstance/clusters/mycluster+. Fields marked +OutputOnly+ must be left blank. Currently exactly one cluster must be specified. A hash of the same form as Google::Bigtable::Admin::V2::Cluster can also be provided.

  • options (Google::Gax::CallOptions) —

    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.



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 511

def create_instance \
    parent,
    instance_id,
    instance,
    clusters,
    options: nil
  req = {
    parent: parent,
    instance_id: instance_id,
    instance: instance,
    clusters: clusters
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::CreateInstanceRequest)
  operation = Google::Gax::Operation.new(
    @create_instance.call(req, options),
    @operations_client,
    Google::Bigtable::Admin::V2::Instance,
    Google::Bigtable::Admin::V2::CreateInstanceMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

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

Deletes an app profile from an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.app_profile_path("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]")

# TODO: Initialize +ignore_warnings+:
ignore_warnings = false
bigtable_instance_admin_client.delete_app_profile(formatted_name, ignore_warnings)

Parameters:

  • name (String) —

    The unique name of the app profile to be deleted. Values are of the form +projects//instances//appProfiles/+.

  • ignore_warnings (true, false) —

    If true, ignore safety checks when deleting the app profile.

  • options (Google::Gax::CallOptions) —

    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.



1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1281

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

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

Deletes a cluster from an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.cluster_path("[PROJECT]", "[INSTANCE]", "[CLUSTER]")
bigtable_instance_admin_client.delete_cluster(formatted_name)

Parameters:

  • name (String) —

    The unique name of the cluster to be deleted. Values are of the form +projects//instances//clusters/+.

  • options (Google::Gax::CallOptions) —

    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.



1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1033

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

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

Delete an instance from a project.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
bigtable_instance_admin_client.delete_instance(formatted_name)

Parameters:

  • name (String) —

    The unique name of the instance to be deleted. Values are of the form +projects//instances/+.

  • options (Google::Gax::CallOptions) —

    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.



764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 764

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

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

Gets information about an app profile.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.app_profile_path("[PROJECT]", "[INSTANCE]", "[APP_PROFILE]")
response = bigtable_instance_admin_client.get_app_profile(formatted_name)

Parameters:

  • name (String) —

    The unique name of the requested app profile. Values are of the form +projects//instances//appProfiles/+.

  • options (Google::Gax::CallOptions) —

    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.



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1120

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

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

Gets information about a cluster.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.cluster_path("[PROJECT]", "[INSTANCE]", "[CLUSTER]")
response = bigtable_instance_admin_client.get_cluster(formatted_name)

Parameters:

  • name (String) —

    The unique name of the requested cluster. Values are of the form +projects//instances//clusters/+.

  • options (Google::Gax::CallOptions) —

    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.



877
878
879
880
881
882
883
884
885
886
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 877

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

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

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

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
response = bigtable_instance_admin_client.get_iam_policy(formatted_resource)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/{project}+.

  • options (Google::Gax::CallOptions) —

    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.



1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1317

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

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

Gets information about an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
response = bigtable_instance_admin_client.get_instance(formatted_name)

Parameters:

  • name (String) —

    The unique name of the requested instance. Values are of the form +projects//instances/+.

  • options (Google::Gax::CallOptions) —

    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.



555
556
557
558
559
560
561
562
563
564
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 555

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

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

Lists information about app profiles in an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# Iterate over all results.
bigtable_instance_admin_client.list_app_profiles(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
bigtable_instance_admin_client.list_app_profiles(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 a list of app profiles is requested. Values are of the form +projects//instances/+.

  • options (Google::Gax::CallOptions) —

    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::AppProfile>) —

    An enumerable of Google::Bigtable::Admin::V2::AppProfile 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.



1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1168

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

#list_clusters(parent, page_token: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::ListClustersResponse

Lists information about clusters in an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
response = bigtable_instance_admin_client.list_clusters(formatted_parent)

Parameters:

  • parent (String) —

    The unique name of the instance for which a list of clusters is requested. Values are of the form +projects//instances/+. Use + = '-'+ to list Clusters for all Instances in a project, e.g., +projects/myproject/instances/-+.

  • page_token (String) —

    The value of +next_page_token+ returned by a previous call.

  • options (Google::Gax::CallOptions) —

    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.



912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 912

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

#list_instances(parent, page_token: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::ListInstancesResponse

Lists information about instances in a project.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_parent = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.project_path("[PROJECT]")
response = bigtable_instance_admin_client.list_instances(formatted_parent)

Parameters:

  • parent (String) —

    The unique name of the project for which a list of instances is requested. Values are of the form +projects/+.

  • page_token (String) —

    The value of +next_page_token+ returned by a previous call.

  • options (Google::Gax::CallOptions) —

    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.



588
589
590
591
592
593
594
595
596
597
598
599
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 588

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

#partial_update_instance(instance, update_mask, options: nil) ⇒ Google::Gax::Operation

Partially updates an instance within a project.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)

# TODO: Initialize +instance+:
instance = {}

# TODO: Initialize +update_mask+:
update_mask = {}

# Register a callback during the method call.
operation = bigtable_instance_admin_client.partial_update_instance(instance, update_mask) 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:

  • instance (Google::Bigtable::Admin::V2::Instance | Hash) —

    The Instance which will (partially) replace the current value. A hash of the same form as Google::Bigtable::Admin::V2::Instance can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    The subset of Instance fields which should be replaced. Must be explicitly set. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) —

    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.



725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 725

def partial_update_instance \
    instance,
    update_mask,
    options: nil
  req = {
    instance: instance,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::PartialUpdateInstanceRequest)
  operation = Google::Gax::Operation.new(
    @partial_update_instance.call(req, options),
    @operations_client,
    Google::Bigtable::Admin::V2::Instance,
    Google::Bigtable::Admin::V2::UpdateInstanceMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

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

Sets the access control policy on an instance resource. Replaces any existing policy.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize +policy+:
policy = {}
response = bigtable_instance_admin_client.set_iam_policy(formatted_resource, policy)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/{project}+.

  • 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) —

    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.



1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1360

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

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

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

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_resource = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize +permissions+:
permissions = []
response = bigtable_instance_admin_client.test_iam_permissions(formatted_resource, permissions)

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. +resource+ is usually specified as a path. For example, a Project resource is specified as +projects/{project}+.

  • 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) —

    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.



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1402

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

#update_app_profile(app_profile, update_mask, ignore_warnings: nil, options: nil) ⇒ Google::Gax::Operation

Updates an app profile within an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)

# TODO: Initialize +app_profile+:
app_profile = {}

# TODO: Initialize +update_mask+:
update_mask = {}

# Register a callback during the method call.
operation = bigtable_instance_admin_client.update_app_profile(app_profile, update_mask) 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:

  • app_profile (Google::Bigtable::Admin::V2::AppProfile | Hash) —

    The app profile which will (partially) replace the current value. A hash of the same form as Google::Bigtable::Admin::V2::AppProfile can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    The subset of app profile fields which should be replaced. If unset, all fields will be replaced. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • ignore_warnings (true, false) —

    If true, ignore safety checks when updating the app profile.

  • options (Google::Gax::CallOptions) —

    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.



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1235

def update_app_profile \
    app_profile,
    update_mask,
    ignore_warnings: nil,
    options: nil
  req = {
    app_profile: app_profile,
    update_mask: update_mask,
    ignore_warnings: ignore_warnings
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::UpdateAppProfileRequest)
  operation = Google::Gax::Operation.new(
    @update_app_profile.call(req, options),
    @operations_client,
    Google::Bigtable::Admin::V2::AppProfile,
    Google::Bigtable::Admin::V2::UpdateAppProfileMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#update_cluster(name, serve_nodes, location: nil, state: nil, default_storage_type: nil, options: nil) ⇒ Google::Gax::Operation

Updates a cluster within an instance.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.cluster_path("[PROJECT]", "[INSTANCE]", "[CLUSTER]")

# TODO: Initialize +serve_nodes+:
serve_nodes = 0

# Register a callback during the method call.
operation = bigtable_instance_admin_client.update_cluster(formatted_name, serve_nodes) 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) —

    (+OutputOnly+) The unique name of the cluster. Values are of the form +projects//instances//clusters/[a-z][-a-z0-9]*+.

  • serve_nodes (Integer) —

    The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance.

  • location (String) —

    (+CreationOnly+) The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form +projects//locations/+.

  • state (Google::Bigtable::Admin::V2::Cluster::State) —

    (+OutputOnly+) The current state of the cluster.

  • default_storage_type (Google::Bigtable::Admin::V2::StorageType) —

    (+CreationOnly+) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.

  • options (Google::Gax::CallOptions) —

    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.



988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 988

def update_cluster \
    name,
    serve_nodes,
    location: nil,
    state: nil,
    default_storage_type: nil,
    options: nil
  req = {
    name: name,
    serve_nodes: serve_nodes,
    location: location,
    state: state,
    default_storage_type: default_storage_type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::Cluster)
  operation = Google::Gax::Operation.new(
    @update_cluster.call(req, options),
    @operations_client,
    Google::Bigtable::Admin::V2::Cluster,
    Google::Bigtable::Admin::V2::UpdateClusterMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#update_instance(name, display_name, type, labels, state: nil, options: nil) {|result, operation| ... } ⇒ Google::Bigtable::Admin::V2::Instance

Updates an instance within a project.

Examples:

require "google/cloud/bigtable/admin"

bigtable_instance_admin_client = Google::Cloud::Bigtable::Admin::BigtableInstanceAdmin.new(version: :v2)
formatted_name = Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")

# TODO: Initialize +display_name+:
display_name = ''

# TODO: Initialize +type+:
type = :TYPE_UNSPECIFIED

# TODO: Initialize +labels+:
labels = {}
response = bigtable_instance_admin_client.update_instance(formatted_name, display_name, type, labels)

Parameters:

  • name (String) —

    (+OutputOnly+) The unique name of the instance. Values are of the form +projects//instances/[a-z][a-z0-9\-]+[a-z0-9]+.

  • display_name (String) —

    The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.

  • type (Google::Bigtable::Admin::V2::Instance::Type) —

    The type of the instance. Defaults to +PRODUCTION+.

  • labels (Hash{String => String}) —

    Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics.

    • Label keys must be between 1 and 63 characters long and must conform to the regular expression: +[\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62}+.
    • Label values must be between 0 and 63 characters long and must conform to the regular expression: +[\p{Ll}\p{Lo}\p{N}_-]{0,63}+.
    • No more than 64 labels can be associated with a given resource.
    • Keys and values must both be under 128 bytes.
  • state (Google::Bigtable::Admin::V2::Instance::State) —

    (+OutputOnly+) The current state of the instance.

  • options (Google::Gax::CallOptions) —

    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.



652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 652

def update_instance \
    name,
    display_name,
    type,
    labels,
    state: nil,
    options: nil,
    &block
  req = {
    name: name,
    display_name: display_name,
    type: type,
    labels: labels,
    state: state
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Bigtable::Admin::V2::Instance)
  @update_instance.call(req, options, &block)
end