Class: Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb

Overview

Cloud Spanner Instance Admin API

The Cloud Spanner Instance Admin API can be used to create, delete, modify and list instances. Instances are dedicated Cloud Spanner serving and storage resources to be used by Cloud Spanner databases.

Each instance has a “configuration”, which dictates where the serving resources for the Cloud Spanner instance are located (e.g., US-central, Europe). Configurations are created by Google based on resource availability.

Cloud Spanner billing is based on the instances that exist and their sizes. After an instance exists, there are no additional per-database or per-operation charges for use of the instance (though there may be additional network bandwidth charges). Instances offer isolation: problems with databases in one instance will not affect other instances. However, within an instance databases can affect each other. For example, if one database in an instance receives a lot of requests and consumes most of the instance resources, fewer resources are available for other databases in that instance, and their performance may suffer.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"spanner.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
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/cloud-platform",
  "https://www.googleapis.com/auth/spanner.admin"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ InstanceAdminClient

Returns a new instance of InstanceAdminClient.

Parameters:

  • service_path (String) (defaults to: SERVICE_ADDRESS) —

    The domain name of the API remote host.

  • port (Integer) (defaults to: DEFAULT_SERVICE_PORT) —

    The port on which to connect to the remote host.

  • channel (Channel) (defaults to: nil) —

    A Channel object through which to make calls.

  • chan_creds (Grpc::ChannelCredentials) (defaults to: nil) —

    A ChannelCredentials for the setting up the RPC client.

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



194
195
196
197
198
199
200
201
202
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
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 194

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: nil,
    app_version: 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/spanner/admin/instance/v1/spanner_instance_admin_services_pb"

  @operations_client = Google::Longrunning::OperationsClient.new(
    service_path: service_path,
    port: port,
    channel: channel,
    chan_creds: chan_creds,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    app_name: app_name,
    app_version: app_version,
    lib_name: lib_name,
    lib_version: lib_version,
  )

  if app_name || app_version
    warn "`app_name` and `app_version` are no longer being used in the request headers."
  end

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

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "instance_admin_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.spanner.admin.instance.v1.InstanceAdmin",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @instance_admin_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    scopes: scopes,
    &Google::Spanner::Admin::Instance::V1::InstanceAdmin::Stub.method(:new)
  )

  @list_instance_configs = Google::Gax.create_api_call(
    @instance_admin_stub.method(:list_instance_configs),
    defaults["list_instance_configs"]
  )
  @get_instance_config = Google::Gax.create_api_call(
    @instance_admin_stub.method(:get_instance_config),
    defaults["get_instance_config"]
  )
  @list_instances = Google::Gax.create_api_call(
    @instance_admin_stub.method(:list_instances),
    defaults["list_instances"]
  )
  @get_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:get_instance),
    defaults["get_instance"]
  )
  @create_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:create_instance),
    defaults["create_instance"]
  )
  @update_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:update_instance),
    defaults["update_instance"]
  )
  @delete_instance = Google::Gax.create_api_call(
    @instance_admin_stub.method(:delete_instance),
    defaults["delete_instance"]
  )
  @set_iam_policy = Google::Gax.create_api_call(
    @instance_admin_stub.method(:set_iam_policy),
    defaults["set_iam_policy"]
  )
  @get_iam_policy = Google::Gax.create_api_call(
    @instance_admin_stub.method(:get_iam_policy),
    defaults["get_iam_policy"]
  )
  @test_iam_permissions = Google::Gax.create_api_call(
    @instance_admin_stub.method(:test_iam_permissions),
    defaults["test_iam_permissions"]
  )
end

Instance Attribute Details

#instance_admin_stub ⇒ Google::Spanner::Admin::Instance::V1::InstanceAdmin::Stub (readonly)

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 64

class InstanceAdminClient
  attr_reader :instance_admin_stub

  # The default address of the service.
  SERVICE_ADDRESS = "spanner.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_instance_configs" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "instance_configs"),
    "list_instances" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "instances")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/spanner.admin"
  ].freeze

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  INSTANCE_CONFIG_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/instanceConfigs/{instance_config}"
  )

  private_constant :INSTANCE_CONFIG_PATH_TEMPLATE

  INSTANCE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/instances/{instance}"
  )

  private_constant :INSTANCE_PATH_TEMPLATE

  # Returns a fully-qualified project resource name string.
  # @param project [String]
  # @return [String]
  def self.project_path project
    PROJECT_PATH_TEMPLATE.render(
      :"project" => project
    )
  end

  # Returns a fully-qualified instance_config resource name string.
  # @param project [String]
  # @param instance_config [String]
  # @return [String]
  def self.instance_config_path project, instance_config
    INSTANCE_CONFIG_PATH_TEMPLATE.render(
      :"project" => project,
      :"instance_config" => instance_config
    )
  end

  # Returns a fully-qualified instance resource name string.
  # @param project [String]
  # @param instance [String]
  # @return [String]
  def self.instance_path project, instance
    INSTANCE_PATH_TEMPLATE.render(
      :"project" => project,
      :"instance" => instance
    )
  end

  # Parses the project from a project resource.
  # @param project_name [String]
  # @return [String]
  def self.match_project_from_project_name project_name
    PROJECT_PATH_TEMPLATE.match(project_name)["project"]
  end

  # Parses the project from a instance_config resource.
  # @param instance_config_name [String]
  # @return [String]
  def self.match_project_from_instance_config_name instance_config_name
    INSTANCE_CONFIG_PATH_TEMPLATE.match(instance_config_name)["project"]
  end

  # Parses the instance_config from a instance_config resource.
  # @param instance_config_name [String]
  # @return [String]
  def self.match_instance_config_from_instance_config_name instance_config_name
    INSTANCE_CONFIG_PATH_TEMPLATE.match(instance_config_name)["instance_config"]
  end

  # Parses the project from a instance resource.
  # @param instance_name [String]
  # @return [String]
  def self.match_project_from_instance_name instance_name
    INSTANCE_PATH_TEMPLATE.match(instance_name)["project"]
  end

  # Parses the instance from a instance resource.
  # @param instance_name [String]
  # @return [String]
  def self.match_instance_from_instance_name instance_name
    INSTANCE_PATH_TEMPLATE.match(instance_name)["instance"]
  end

  # @param service_path [String]
  #   The domain name of the API remote host.
  # @param port [Integer]
  #   The port on which to connect to the remote host.
  # @param channel [Channel]
  #   A Channel object through which to make calls.
  # @param chan_creds [Grpc::ChannelCredentials]
  #   A ChannelCredentials for the setting up the RPC client.
  # @param 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.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: nil,
      app_version: 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/spanner/admin/instance/v1/spanner_instance_admin_services_pb"

    @operations_client = Google::Longrunning::OperationsClient.new(
      service_path: service_path,
      port: port,
      channel: channel,
      chan_creds: chan_creds,
      scopes: scopes,
      client_config: client_config,
      timeout: timeout,
      app_name: app_name,
      app_version: app_version,
      lib_name: lib_name,
      lib_version: lib_version,
    )

    if app_name || app_version
      warn "`app_name` and `app_version` are no longer being used in the request headers."
    end

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

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "instance_admin_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.spanner.admin.instance.v1.InstanceAdmin",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @instance_admin_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Spanner::Admin::Instance::V1::InstanceAdmin::Stub.method(:new)
    )

    @list_instance_configs = Google::Gax.create_api_call(
      @instance_admin_stub.method(:list_instance_configs),
      defaults["list_instance_configs"]
    )
    @get_instance_config = Google::Gax.create_api_call(
      @instance_admin_stub.method(:get_instance_config),
      defaults["get_instance_config"]
    )
    @list_instances = Google::Gax.create_api_call(
      @instance_admin_stub.method(:list_instances),
      defaults["list_instances"]
    )
    @get_instance = Google::Gax.create_api_call(
      @instance_admin_stub.method(:get_instance),
      defaults["get_instance"]
    )
    @create_instance = Google::Gax.create_api_call(
      @instance_admin_stub.method(:create_instance),
      defaults["create_instance"]
    )
    @update_instance = Google::Gax.create_api_call(
      @instance_admin_stub.method(:update_instance),
      defaults["update_instance"]
    )
    @delete_instance = Google::Gax.create_api_call(
      @instance_admin_stub.method(:delete_instance),
      defaults["delete_instance"]
    )
    @set_iam_policy = Google::Gax.create_api_call(
      @instance_admin_stub.method(:set_iam_policy),
      defaults["set_iam_policy"]
    )
    @get_iam_policy = Google::Gax.create_api_call(
      @instance_admin_stub.method(:get_iam_policy),
      defaults["get_iam_policy"]
    )
    @test_iam_permissions = Google::Gax.create_api_call(
      @instance_admin_stub.method(:test_iam_permissions),
      defaults["test_iam_permissions"]
    )
  end

  # Service calls

  # Lists the supported instance configurations for a given project.
  #
  # @param parent [String]
  #   Required. The name of the project for which a list of supported instance
  #   configurations is requested. Values are of the form
  #   +projects/<project>+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::InstanceConfig>]
  #   An enumerable of Google::Spanner::Admin::Instance::V1::InstanceConfig instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_parent = InstanceAdminClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   instance_admin_client.list_instance_configs(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   instance_admin_client.list_instance_configs(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_instance_configs \
      parent,
      page_size: nil,
      options: nil
    req = Google::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest.new({
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? })
    @list_instance_configs.call(req, options)
  end

  # Gets information about a particular instance configuration.
  #
  # @param name [String]
  #   Required. The name of the requested instance configuration. Values are of
  #   the form +projects/<project>/instanceConfigs/<config>+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::Admin::Instance::V1::InstanceConfig]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_name = InstanceAdminClient.instance_config_path("[PROJECT]", "[INSTANCE_CONFIG]")
  #   response = instance_admin_client.get_instance_config(formatted_name)

  def get_instance_config \
      name,
      options: nil
    req = Google::Spanner::Admin::Instance::V1::GetInstanceConfigRequest.new({
      name: name
    }.delete_if { |_, v| v.nil? })
    @get_instance_config.call(req, options)
  end

  # Lists all instances in the given project.
  #
  # @param parent [String]
  #   Required. The name of the project for which a list of instances is
  #   requested. Values are of the form +projects/<project>+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param filter [String]
  #   An expression for filtering the results of the request. Filter rules are
  #   case insensitive. The fields eligible for filtering are:
  #
  #     * name
  #     * display_name
  #     * labels.key where key is the name of a label
  #
  #   Some examples of using filters are:
  #
  #     * name:* --> The instance has a name.
  #     * name:Howl --> The instance's name contains the string "howl".
  #     * name:HOWL --> Equivalent to above.
  #     * NAME:howl --> Equivalent to above.
  #     * labels.env:* --> The instance has the label "env".
  #     * labels.env:dev --> The instance has the label "env" and the value of
  #                          the label contains the string "dev".
  #     * name:howl labels.env:dev --> The instance's name contains "howl" and
  #                                    it has the label "env" with its value
  #                                    containing "dev".
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::Instance>]
  #   An enumerable of Google::Spanner::Admin::Instance::V1::Instance instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_parent = InstanceAdminClient.project_path("[PROJECT]")
  #
  #   # Iterate over all results.
  #   instance_admin_client.list_instances(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   instance_admin_client.list_instances(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_instances \
      parent,
      page_size: nil,
      filter: nil,
      options: nil
    req = Google::Spanner::Admin::Instance::V1::ListInstancesRequest.new({
      parent: parent,
      page_size: page_size,
      filter: filter
    }.delete_if { |_, v| v.nil? })
    @list_instances.call(req, options)
  end

  # Gets information about a particular instance.
  #
  # @param name [String]
  #   Required. The name of the requested instance. Values are of the form
  #   +projects/<project>/instances/<instance>+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::Admin::Instance::V1::Instance]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_name = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
  #   response = instance_admin_client.get_instance(formatted_name)

  def get_instance \
      name,
      options: nil
    req = Google::Spanner::Admin::Instance::V1::GetInstanceRequest.new({
      name: name
    }.delete_if { |_, v| v.nil? })
    @get_instance.call(req, options)
  end

  # Creates an instance and begins preparing it to begin serving. The
  # returned Long-running operation
  # can be used to track the progress of preparing the new
  # instance. The instance name is assigned by the caller. If the
  # named instance already exists, +CreateInstance+ returns
  # +ALREADY_EXISTS+.
  #
  # Immediately upon completion of this request:
  #
  #   * The instance is readable via the API, with all requested attributes
  #     but no allocated resources. Its state is +CREATING+.
  #
  # Until completion of the returned operation:
  #
  #   * Cancelling the operation renders the instance immediately unreadable
  #     via the API.
  #   * The instance can be deleted.
  #   * All other attempts to modify the instance are rejected.
  #
  # Upon completion of the returned operation:
  #
  #   * Billing for all successfully-allocated resources begins (some types
  #     may have lower than the requested levels).
  #   * Databases can be created in the instance.
  #   * The instance's allocated resource levels are readable via the API.
  #   * The instance's state becomes +READY+.
  #
  # The returned Long-running operation will
  # have a name of the format +<instance_name>/operations/<operation_id>+ and
  # can be used to track creation of the instance.  The
  # Metadata field type is
  # CreateInstanceMetadata.
  # The Response field type is
  # Instance, if successful.
  #
  # @param parent [String]
  #   Required. The name of the project in which to create the instance. Values
  #   are of the form +projects/<project>+.
  # @param instance_id [String]
  #   Required. The ID of the instance to create.  Valid identifiers are of the
  #   form +[a-z][-a-z0-9]*[a-z0-9]+ and must be between 6 and 30 characters in
  #   length.
  # @param instance [Google::Spanner::Admin::Instance::V1::Instance]
  #   Required. The instance to create.  The name may be omitted, but if
  #   specified must be +<parent>/instances/<instance_id>+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   Instance = Google::Spanner::Admin::Instance::V1::Instance
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_parent = InstanceAdminClient.project_path("[PROJECT]")
  #   instance_id = ''
  #   instance = Instance.new
  #
  #   # Register a callback during the method call.
  #   operation = instance_admin_client.create_instance(formatted_parent, instance_id, instance) 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!

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

  # Updates an instance, and begins allocating or releasing resources
  # as requested. The returned Long-running
  # operation can be used to track the
  # progress of updating the instance. If the named instance does not
  # exist, returns +NOT_FOUND+.
  #
  # Immediately upon completion of this request:
  #
  #   * For resource types for which a decrease in the instance's allocation
  #     has been requested, billing is based on the newly-requested level.
  #
  # Until completion of the returned operation:
  #
  #   * Cancelling the operation sets its metadata's
  #     Cancel_time, and begins
  #     restoring resources to their pre-request values. The operation
  #     is guaranteed to succeed at undoing all resource changes,
  #     after which point it terminates with a +CANCELLED+ status.
  #   * All other attempts to modify the instance are rejected.
  #   * Reading the instance via the API continues to give the pre-request
  #     resource levels.
  #
  # Upon completion of the returned operation:
  #
  #   * Billing begins for all successfully-allocated resources (some types
  #     may have lower than the requested levels).
  #   * All newly-reserved resources are available for serving the instance's
  #     tables.
  #   * The instance's new resource levels are readable via the API.
  #
  # The returned Long-running operation will
  # have a name of the format +<instance_name>/operations/<operation_id>+ and
  # can be used to track the instance modification.  The
  # Metadata field type is
  # UpdateInstanceMetadata.
  # The Response field type is
  # Instance, if successful.
  #
  # Authorization requires +spanner.instances.update+ permission on
  # resource Name.
  #
  # @param instance [Google::Spanner::Admin::Instance::V1::Instance]
  #   Required. The instance to update, which must always include the instance
  #   name.  Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.
  # @param field_mask [Google::Protobuf::FieldMask]
  #   Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated.
  #   The field mask must always be specified; this prevents any future fields in
  #   [][google.spanner.admin.instance.v1.Instance] from being erased accidentally by clients that do not know
  #   about them.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   FieldMask = Google::Protobuf::FieldMask
  #   Instance = Google::Spanner::Admin::Instance::V1::Instance
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   instance = Instance.new
  #   field_mask = FieldMask.new
  #
  #   # Register a callback during the method call.
  #   operation = instance_admin_client.update_instance(instance, field_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!

  def update_instance \
      instance,
      field_mask,
      options: nil
    req = Google::Spanner::Admin::Instance::V1::UpdateInstanceRequest.new({
      instance: instance,
      field_mask: field_mask
    }.delete_if { |_, v| v.nil? })
    operation = Google::Gax::Operation.new(
      @update_instance.call(req, options),
      @operations_client,
      Google::Spanner::Admin::Instance::V1::Instance,
      Google::Spanner::Admin::Instance::V1::UpdateInstanceMetadata,
      call_options: options
    )
    operation.on_done { |operation| yield(operation) } if block_given?
    operation
  end

  # Deletes an instance.
  #
  # Immediately upon completion of the request:
  #
  #   * Billing ceases for all of the instance's reserved resources.
  #
  # Soon afterward:
  #
  #   * The instance and *all of its databases* immediately and
  #     irrevocably disappear from the API. All data in the databases
  #     is permanently deleted.
  #
  # @param name [String]
  #   Required. The name of the instance to be deleted. Values are of the form
  #   +projects/<project>/instances/<instance>+
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_name = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
  #   instance_admin_client.delete_instance(formatted_name)

  def delete_instance \
      name,
      options: nil
    req = Google::Spanner::Admin::Instance::V1::DeleteInstanceRequest.new({
      name: name
    }.delete_if { |_, v| v.nil? })
    @delete_instance.call(req, options)
    nil
  end

  # Sets the access control policy on an instance resource. Replaces any
  # existing policy.
  #
  # Authorization requires +spanner.instances.setIamPolicy+ on
  # Resource.
  #
  # @param 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}+.
  # @param policy [Google::Iam::V1::Policy]
  #   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.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #   Policy = Google::Iam::V1::Policy
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_resource = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
  #   policy = Policy.new
  #   response = instance_admin_client.set_iam_policy(formatted_resource, policy)

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

  # Gets the access control policy for an instance resource. Returns an empty
  # policy if an instance exists but does not have a policy set.
  #
  # Authorization requires +spanner.instances.getIamPolicy+ on
  # Resource.
  #
  # @param 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}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::Policy]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_resource = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
  #   response = instance_admin_client.get_iam_policy(formatted_resource)

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

  # Returns permissions that the caller has on the specified instance resource.
  #
  # Attempting this RPC on a non-existent Cloud Spanner instance resource will
  # result in a NOT_FOUND error if the user has +spanner.instances.list+
  # permission on the containing Google Cloud Project. Otherwise returns an
  # empty set of permissions.
  #
  # @param 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}+.
  # @param 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}[https://cloud.google.com/iam/docs/overview#permissions].
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Iam::V1::TestIamPermissionsResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/admin/instance/v1/instance_admin_client"
  #
  #   InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
  #
  #   instance_admin_client = InstanceAdminClient.new
  #   formatted_resource = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
  #   permissions = []
  #   response = instance_admin_client.test_iam_permissions(formatted_resource, permissions)

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

Class Method Details

.instance_config_path(project, instance_config) ⇒ String

Returns a fully-qualified instance_config resource name string.

Parameters:

  • project (String)
  • instance_config (String)

Returns:

  • (String) 


126
127
128
129
130
131
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 126

def self.instance_config_path project, instance_config
  INSTANCE_CONFIG_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance_config" => instance_config
  )
end

.instance_path(project, instance) ⇒ String

Returns a fully-qualified instance resource name string.

Parameters:

  • project (String)
  • instance (String)

Returns:

  • (String) 


137
138
139
140
141
142
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 137

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

.match_instance_config_from_instance_config_name(instance_config_name) ⇒ String

Parses the instance_config from a instance_config resource.

Parameters:

  • instance_config_name (String)

Returns:

  • (String) 


161
162
163
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 161

def self.match_instance_config_from_instance_config_name instance_config_name
  INSTANCE_CONFIG_PATH_TEMPLATE.match(instance_config_name)["instance_config"]
end

.match_instance_from_instance_name(instance_name) ⇒ String

Parses the instance from a instance resource.

Parameters:

  • instance_name (String)

Returns:

  • (String) 


175
176
177
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 175

def self.match_instance_from_instance_name instance_name
  INSTANCE_PATH_TEMPLATE.match(instance_name)["instance"]
end

.match_project_from_instance_config_name(instance_config_name) ⇒ String

Parses the project from a instance_config resource.

Parameters:

  • instance_config_name (String)

Returns:

  • (String) 


154
155
156
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 154

def self.match_project_from_instance_config_name instance_config_name
  INSTANCE_CONFIG_PATH_TEMPLATE.match(instance_config_name)["project"]
end

.match_project_from_instance_name(instance_name) ⇒ String

Parses the project from a instance resource.

Parameters:

  • instance_name (String)

Returns:

  • (String) 


168
169
170
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 168

def self.match_project_from_instance_name instance_name
  INSTANCE_PATH_TEMPLATE.match(instance_name)["project"]
end

.match_project_from_project_name(project_name) ⇒ String

Parses the project from a project resource.

Parameters:

  • project_name (String)

Returns:

  • (String) 


147
148
149
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 147

def self.match_project_from_project_name project_name
  PROJECT_PATH_TEMPLATE.match(project_name)["project"]
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


116
117
118
119
120
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 116

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

Instance Method Details

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

Creates an instance and begins preparing it to begin serving. The returned Long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, CreateInstance returns ALREADY_EXISTS.

Immediately upon completion of this request:

* The instance is readable via the API, with all requested attributes
  but no allocated resources. Its state is +CREATING+.

Until completion of the returned operation:

* Cancelling the operation renders the instance immediately unreadable
  via the API.
* The instance can be deleted.
* All other attempts to modify the instance are rejected.

Upon completion of the returned operation:

* Billing for all successfully-allocated resources begins (some types
  may have lower than the requested levels).
* Databases can be created in the instance.
* The instance's allocated resource levels are readable via the API.
* The instance's state becomes +READY+.

The returned Long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track creation of the instance. The Metadata field type is CreateInstanceMetadata. The Response field type is Instance, if successful.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

Instance = Google::Spanner::Admin::Instance::V1::Instance
InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_parent = InstanceAdminClient.project_path("[PROJECT]")
instance_id = ''
instance = Instance.new

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

  • instance_id (String) —

    Required. The ID of the instance to create. Valid identifiers are of the form [a-z]*[a-z0-9] and must be between 6 and 30 characters in length.

  • instance (Google::Spanner::Admin::Instance::V1::Instance) —

    Required. The instance to create. The name may be omitted, but if specified must be <parent>/instances/<instance_id>.

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



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 576

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

#delete_instance(name, options: nil) ⇒ Object

Deletes an instance.

Immediately upon completion of the request:

* Billing ceases for all of the instance's reserved resources.

Soon afterward:

* The instance and *all of its databases* immediately and
  irrevocably disappear from the API. All data in the databases
  is permanently deleted.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_name = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
instance_admin_client.delete_instance(formatted_name)

Parameters:

  • name (String) —

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

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



736
737
738
739
740
741
742
743
744
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 736

def delete_instance \
    name,
    options: nil
  req = Google::Spanner::Admin::Instance::V1::DeleteInstanceRequest.new({
    name: name
  }.delete_if { |_, v| v.nil? })
  @delete_instance.call(req, options)
  nil
end

#get_iam_policy(resource, options: nil) ⇒ 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.

Authorization requires spanner.instances.getIamPolicy on Resource.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_resource = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
response = 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) (defaults to: nil) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



812
813
814
815
816
817
818
819
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 812

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

#get_instance(name, options: nil) ⇒ Google::Spanner::Admin::Instance::V1::Instance

Gets information about a particular instance.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_name = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
response = instance_admin_client.get_instance(formatted_name)

Parameters:

  • name (String) —

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



479
480
481
482
483
484
485
486
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 479

def get_instance \
    name,
    options: nil
  req = Google::Spanner::Admin::Instance::V1::GetInstanceRequest.new({
    name: name
  }.delete_if { |_, v| v.nil? })
  @get_instance.call(req, options)
end

#get_instance_config(name, options: nil) ⇒ Google::Spanner::Admin::Instance::V1::InstanceConfig

Gets information about a particular instance configuration.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_name = InstanceAdminClient.instance_config_path("[PROJECT]", "[INSTANCE_CONFIG]")
response = instance_admin_client.get_instance_config(formatted_name)

Parameters:

  • name (String) —

    Required. The name of the requested instance configuration. Values are of the form projects/<project>/instanceConfigs/<config>.

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

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



377
378
379
380
381
382
383
384
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 377

def get_instance_config \
    name,
    options: nil
  req = Google::Spanner::Admin::Instance::V1::GetInstanceConfigRequest.new({
    name: name
  }.delete_if { |_, v| v.nil? })
  @get_instance_config.call(req, options)
end

#list_instance_configs(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::InstanceConfig>

Lists the supported instance configurations for a given project.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_parent = InstanceAdminClient.project_path("[PROJECT]")

# Iterate over all results.
instance_admin_client.list_instance_configs(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
instance_admin_client.list_instance_configs(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 name of the project for which a list of supported instance configurations is requested. Values are of the form projects/<project>.

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

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

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

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

Returns:

  • (Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::InstanceConfig>) —

    An enumerable of Google::Spanner::Admin::Instance::V1::InstanceConfig 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.



347
348
349
350
351
352
353
354
355
356
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 347

def list_instance_configs \
    parent,
    page_size: nil,
    options: nil
  req = Google::Spanner::Admin::Instance::V1::ListInstanceConfigsRequest.new({
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? })
  @list_instance_configs.call(req, options)
end

#list_instances(parent, page_size: nil, filter: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::Instance>

Lists all instances in the given project.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_parent = InstanceAdminClient.project_path("[PROJECT]")

# Iterate over all results.
instance_admin_client.list_instances(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
instance_admin_client.list_instances(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 name of the project for which a list of instances is requested. Values are of the form projects/<project>.

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

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

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

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    * name
* display_name
* labels.key where key is the name of a label

    Some examples of using filters are:

    * name:* --> The instance has a name.
* name:Howl --> The instance's name contains the string "howl".
* name:HOWL --> Equivalent to above.
* NAME:howl --> Equivalent to above.
* labels.env:* --> The instance has the label "env".
* labels.env:dev --> The instance has the label "env" and the value of
                     the label contains the string "dev".
* name:howl labels.env:dev --> The instance's name contains "howl" and
                               it has the label "env" with its value
                               containing "dev".
  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Returns:

  • (Google::Gax::PagedEnumerable<Google::Spanner::Admin::Instance::V1::Instance>) —

    An enumerable of Google::Spanner::Admin::Instance::V1::Instance 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.



447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 447

def list_instances \
    parent,
    page_size: nil,
    filter: nil,
    options: nil
  req = Google::Spanner::Admin::Instance::V1::ListInstancesRequest.new({
    parent: parent,
    page_size: page_size,
    filter: filter
  }.delete_if { |_, v| v.nil? })
  @list_instances.call(req, options)
end

#set_iam_policy(resource, policy, options: nil) ⇒ Google::Iam::V1::Policy

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

Authorization requires spanner.instances.setIamPolicy on Resource.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient
Policy = Google::Iam::V1::Policy

instance_admin_client = InstanceAdminClient.new
formatted_resource = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
policy = Policy.new
response = 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) —

    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.

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

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

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



777
778
779
780
781
782
783
784
785
786
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 777

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

#test_iam_permissions(resource, permissions, options: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse

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

Attempting this RPC on a non-existent Cloud Spanner instance resource will result in a NOT_FOUND error if the user has spanner.instances.list permission on the containing Google Cloud Project. Otherwise returns an empty set of permissions.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
formatted_resource = InstanceAdminClient.instance_path("[PROJECT]", "[INSTANCE]")
permissions = []
response = 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) (defaults to: nil) —

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

Returns:

  • (Google::Iam::V1::TestIamPermissionsResponse)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



852
853
854
855
856
857
858
859
860
861
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 852

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

#update_instance(instance, field_mask, options: nil) ⇒ Google::Gax::Operation

Updates an instance, and begins allocating or releasing resources as requested. The returned Long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns NOT_FOUND.

Immediately upon completion of this request:

* For resource types for which a decrease in the instance's allocation
  has been requested, billing is based on the newly-requested level.

Until completion of the returned operation:

* Cancelling the operation sets its metadata's
  Cancel_time, and begins
  restoring resources to their pre-request values. The operation
  is guaranteed to succeed at undoing all resource changes,
  after which point it terminates with a +CANCELLED+ status.
* All other attempts to modify the instance are rejected.
* Reading the instance via the API continues to give the pre-request
  resource levels.

Upon completion of the returned operation:

* Billing begins for all successfully-allocated resources (some types
  may have lower than the requested levels).
* All newly-reserved resources are available for serving the instance's
  tables.
* The instance's new resource levels are readable via the API.

The returned Long-running operation will have a name of the format <instance_name>/operations/<operation_id> and can be used to track the instance modification. The Metadata field type is UpdateInstanceMetadata. The Response field type is Instance, if successful.

Authorization requires spanner.instances.update permission on resource Name.

Examples:

require "google/cloud/spanner/admin/instance/v1/instance_admin_client"

FieldMask = Google::Protobuf::FieldMask
Instance = Google::Spanner::Admin::Instance::V1::Instance
InstanceAdminClient = Google::Cloud::Spanner::Admin::Instance::V1::InstanceAdminClient

instance_admin_client = InstanceAdminClient.new
instance = Instance.new
field_mask = FieldMask.new

# Register a callback during the method call.
operation = instance_admin_client.update_instance(instance, field_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::Spanner::Admin::Instance::V1::Instance) —

    Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.field_mask] need be included.

  • field_mask (Google::Protobuf::FieldMask) —

    Required. A mask specifying which fields in [][google.spanner.admin.instance.v1.UpdateInstanceRequest.instance] should be updated. The field mask must always be specified; this prevents any future fields in

    ][google.spanner.admin.instance.v1.Instance

    from being erased accidentally by clients that do not know

    about them.

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



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb', line 689

def update_instance \
    instance,
    field_mask,
    options: nil
  req = Google::Spanner::Admin::Instance::V1::UpdateInstanceRequest.new({
    instance: instance,
    field_mask: field_mask
  }.delete_if { |_, v| v.nil? })
  operation = Google::Gax::Operation.new(
    @update_instance.call(req, options),
    @operations_client,
    Google::Spanner::Admin::Instance::V1::Instance,
    Google::Spanner::Admin::Instance::V1::UpdateInstanceMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end