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, service_address: nil, service_port: 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) (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.



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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 209

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_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,
    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 }
  if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
    headers[:"x-goog-user-project"] = credentials.quota_project_id
  end
  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 = service_address || self.class::SERVICE_ADDRESS
  port = service_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) 


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

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) 


137
138
139
140
141
142
143
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 137

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) 


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

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) 


160
161
162
163
164
165
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 160

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) 


170
171
172
173
174
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 170

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

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

  • app_profile_id (String) —

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

    Required. 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) (defaults to: nil) —

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

  • 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.



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1097

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

    Required. The unique name of the instance in which to create the new cluster. Values are of the form projects/{project}/instances/{instance}.

  • cluster_id (String) —

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

    Required. 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) (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.



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 851

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

    Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

  • instance_id (String) —

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

    Required. 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}) —

    Required. 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, at most four clusters can be specified. A hash of the same form as Google::Bigtable::Admin::V2::Cluster 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.



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 525

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

    Required. The unique name of the app profile to be deleted. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

  • ignore_warnings (true, false) —

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

  • 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.



1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1309

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

    Required. The unique name of the cluster to be deleted. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

  • 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.



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1047

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

    Required. The unique name of the instance to be deleted. Values are of the form projects/{project}/instances/{instance}.

  • 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.



780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 780

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

    Required. The unique name of the requested app profile. Values are of the form projects/{project}/instances/{instance}/appProfiles/{app_profile}.

  • 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.



1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1134

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

    Required. The unique name of the requested cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.

  • 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.



893
894
895
896
897
898
899
900
901
902
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 893

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, 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. 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.



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1349

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

    Required. The unique name of the requested instance. Values are of the form projects/{project}/instances/{instance}.

  • 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.



569
570
571
572
573
574
575
576
577
578
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 569

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, page_size: nil, 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) —

    Required. The unique name of the instance for which a list of app profiles is requested. Values are of the form projects/{project}/instances/{instance}. Use {instance} = '-' to list AppProfiles for all Instances in a project, e.g., projects/myproject/instances/-.

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

    Maximum number of results per page.

    A page_size of zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error.

    Following the first request, subsequent paginated calls are not required to pass a page_size. If a page_size is set in subsequent calls, it must match the page_size given in the first request.

  • 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::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.



1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1194

def list_app_profiles \
    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::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) —

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

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

    DEPRECATED: This field is unused 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:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 928

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

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

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

    DEPRECATED: This field is unused 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:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 602

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. This method can modify all fields of an Instance and is the preferred way to update an Instance.

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

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

    Required. 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) (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.



741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 741

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. 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.



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1393

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. 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.



1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1434

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

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

    Required. 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) (defaults to: nil) —

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

  • 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.



1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1263

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

    The unique name of the cluster. Values are of the form projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*.

  • serve_nodes (Integer) —

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

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

    (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/{project}/locations/{zone}.

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

    The current state of the cluster.

  • default_storage_type (Google::Bigtable::Admin::V2::StorageType) (defaults to: nil) —

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

  • 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.



1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 1002

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. This method updates only the display name and type for an Instance. To update other Instance properties, such as labels, use PartialUpdateInstance.

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

    The unique name of the instance. Values are of the form projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9].

  • display_name (String) —

    Required. 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) (defaults to: nil) —

    (OutputOnly) The current state of the instance.

  • 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.



667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb', line 667

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