google-cloud-bigtable-admin-v2 0.15.0 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -400,14 +400,14 @@ module Google
400
400
  # # Call the create_table_from_snapshot method.
401
401
  # result = client.create_table_from_snapshot request
402
402
  #
403
- # # The returned object is of type Gapic::Operation. You can use this
404
- # # object to check the status of an operation, cancel it, or wait
405
- # # for results. Here is how to block until completion:
403
+ # # The returned object is of type Gapic::Operation. You can use it to
404
+ # # check the status of an operation, cancel it, or wait for results.
405
+ # # Here is how to wait for a response.
406
406
  # result.wait_until_done! timeout: 60
407
407
  # if result.response?
408
408
  # p result.response
409
409
  # else
410
- # puts "Error!"
410
+ # puts "No response received."
411
411
  # end
412
412
  #
413
413
  def create_table_from_snapshot request, options = nil
@@ -509,13 +509,11 @@ module Google
509
509
  # # Call the list_tables method.
510
510
  # result = client.list_tables request
511
511
  #
512
- # # The returned object is of type Gapic::PagedEnumerable. You can
513
- # # iterate over all elements by calling #each, and the enumerable
514
- # # will lazily make API calls to fetch subsequent pages. Other
515
- # # methods are also available for managing paging directly.
516
- # result.each do |response|
512
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
513
+ # # over elements, and API calls will be issued to fetch pages as needed.
514
+ # result.each do |item|
517
515
  # # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::Table.
518
- # p response
516
+ # p item
519
517
  # end
520
518
  #
521
519
  def list_tables request, options = nil
@@ -671,15 +669,17 @@ module Google
671
669
  # @param table [::Google::Cloud::Bigtable::Admin::V2::Table, ::Hash]
672
670
  # Required. The table to update.
673
671
  # The table's `name` field is used to identify the table to update.
674
- # Format:
675
- # `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
676
672
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
677
673
  # Required. The list of fields to update.
678
- # A mask specifying which fields (e.g. `deletion_protection`) in the `table`
674
+ # A mask specifying which fields (e.g. `change_stream_config`) in the `table`
679
675
  # field should be updated. This mask is relative to the `table` field, not to
680
676
  # the request message. The wildcard (*) path is currently not supported.
681
- # Currently UpdateTable is only supported for the following field:
682
- # * `deletion_protection`
677
+ # Currently UpdateTable is only supported for the following fields:
678
+ #
679
+ # * `change_stream_config`
680
+ # * `change_stream_config.retention_period`
681
+ # * `deletion_protection`
682
+ #
683
683
  # If `column_families` is set in `update_mask`, it will return an
684
684
  # UNIMPLEMENTED error.
685
685
  #
@@ -703,14 +703,14 @@ module Google
703
703
  # # Call the update_table method.
704
704
  # result = client.update_table request
705
705
  #
706
- # # The returned object is of type Gapic::Operation. You can use this
707
- # # object to check the status of an operation, cancel it, or wait
708
- # # for results. Here is how to block until completion:
706
+ # # The returned object is of type Gapic::Operation. You can use it to
707
+ # # check the status of an operation, cancel it, or wait for results.
708
+ # # Here is how to wait for a response.
709
709
  # result.wait_until_done! timeout: 60
710
710
  # if result.response?
711
711
  # p result.response
712
712
  # else
713
- # puts "Error!"
713
+ # puts "No response received."
714
714
  # end
715
715
  #
716
716
  def update_table request, options = nil
@@ -885,14 +885,14 @@ module Google
885
885
  # # Call the undelete_table method.
886
886
  # result = client.undelete_table request
887
887
  #
888
- # # The returned object is of type Gapic::Operation. You can use this
889
- # # object to check the status of an operation, cancel it, or wait
890
- # # for results. Here is how to block until completion:
888
+ # # The returned object is of type Gapic::Operation. You can use it to
889
+ # # check the status of an operation, cancel it, or wait for results.
890
+ # # Here is how to wait for a response.
891
891
  # result.wait_until_done! timeout: 60
892
892
  # if result.response?
893
893
  # p result.response
894
894
  # else
895
- # puts "Error!"
895
+ # puts "No response received."
896
896
  # end
897
897
  #
898
898
  def undelete_table request, options = nil
@@ -1373,14 +1373,14 @@ module Google
1373
1373
  # # Call the snapshot_table method.
1374
1374
  # result = client.snapshot_table request
1375
1375
  #
1376
- # # The returned object is of type Gapic::Operation. You can use this
1377
- # # object to check the status of an operation, cancel it, or wait
1378
- # # for results. Here is how to block until completion:
1376
+ # # The returned object is of type Gapic::Operation. You can use it to
1377
+ # # check the status of an operation, cancel it, or wait for results.
1378
+ # # Here is how to wait for a response.
1379
1379
  # result.wait_until_done! timeout: 60
1380
1380
  # if result.response?
1381
1381
  # p result.response
1382
1382
  # else
1383
- # puts "Error!"
1383
+ # puts "No response received."
1384
1384
  # end
1385
1385
  #
1386
1386
  def snapshot_table request, options = nil
@@ -1574,13 +1574,11 @@ module Google
1574
1574
  # # Call the list_snapshots method.
1575
1575
  # result = client.list_snapshots request
1576
1576
  #
1577
- # # The returned object is of type Gapic::PagedEnumerable. You can
1578
- # # iterate over all elements by calling #each, and the enumerable
1579
- # # will lazily make API calls to fetch subsequent pages. Other
1580
- # # methods are also available for managing paging directly.
1581
- # result.each do |response|
1577
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
1578
+ # # over elements, and API calls will be issued to fetch pages as needed.
1579
+ # result.each do |item|
1582
1580
  # # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::Snapshot.
1583
- # p response
1581
+ # p item
1584
1582
  # end
1585
1583
  #
1586
1584
  def list_snapshots request, options = nil
@@ -1777,14 +1775,14 @@ module Google
1777
1775
  # # Call the create_backup method.
1778
1776
  # result = client.create_backup request
1779
1777
  #
1780
- # # The returned object is of type Gapic::Operation. You can use this
1781
- # # object to check the status of an operation, cancel it, or wait
1782
- # # for results. Here is how to block until completion:
1778
+ # # The returned object is of type Gapic::Operation. You can use it to
1779
+ # # check the status of an operation, cancel it, or wait for results.
1780
+ # # Here is how to wait for a response.
1783
1781
  # result.wait_until_done! timeout: 60
1784
1782
  # if result.response?
1785
1783
  # p result.response
1786
1784
  # else
1787
- # puts "Error!"
1785
+ # puts "No response received."
1788
1786
  # end
1789
1787
  #
1790
1788
  def create_backup request, options = nil
@@ -2204,13 +2202,11 @@ module Google
2204
2202
  # # Call the list_backups method.
2205
2203
  # result = client.list_backups request
2206
2204
  #
2207
- # # The returned object is of type Gapic::PagedEnumerable. You can
2208
- # # iterate over all elements by calling #each, and the enumerable
2209
- # # will lazily make API calls to fetch subsequent pages. Other
2210
- # # methods are also available for managing paging directly.
2211
- # result.each do |response|
2205
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
2206
+ # # over elements, and API calls will be issued to fetch pages as needed.
2207
+ # result.each do |item|
2212
2208
  # # Each element is of type ::Google::Cloud::Bigtable::Admin::V2::Backup.
2213
- # p response
2209
+ # p item
2214
2210
  # end
2215
2211
  #
2216
2212
  def list_backups request, options = nil
@@ -2313,14 +2309,14 @@ module Google
2313
2309
  # # Call the restore_table method.
2314
2310
  # result = client.restore_table request
2315
2311
  #
2316
- # # The returned object is of type Gapic::Operation. You can use this
2317
- # # object to check the status of an operation, cancel it, or wait
2318
- # # for results. Here is how to block until completion:
2312
+ # # The returned object is of type Gapic::Operation. You can use it to
2313
+ # # check the status of an operation, cancel it, or wait for results.
2314
+ # # Here is how to wait for a response.
2319
2315
  # result.wait_until_done! timeout: 60
2320
2316
  # if result.response?
2321
2317
  # p result.response
2322
2318
  # else
2323
- # puts "Error!"
2319
+ # puts "No response received."
2324
2320
  # end
2325
2321
  #
2326
2322
  def restore_table request, options = nil
@@ -2683,9 +2679,9 @@ module Google
2683
2679
  # * (`String`) The path to a service account key file in JSON format
2684
2680
  # * (`Hash`) A service account key as a Hash
2685
2681
  # * (`Google::Auth::Credentials`) A googleauth credentials object
2686
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
2682
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
2687
2683
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2688
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
2684
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2689
2685
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
2690
2686
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
2691
2687
  # * (`nil`) indicating no credentials
@@ -159,13 +159,11 @@ module Google
159
159
  # # Call the list_operations method.
160
160
  # result = client.list_operations request
161
161
  #
162
- # # The returned object is of type Gapic::PagedEnumerable. You can
163
- # # iterate over all elements by calling #each, and the enumerable
164
- # # will lazily make API calls to fetch subsequent pages. Other
165
- # # methods are also available for managing paging directly.
166
- # result.each do |response|
162
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
163
+ # # over elements, and API calls will be issued to fetch pages as needed.
164
+ # result.each do |item|
167
165
  # # Each element is of type ::Google::Longrunning::Operation.
168
- # p response
166
+ # p item
169
167
  # end
170
168
  #
171
169
  def list_operations request, options = nil
@@ -254,14 +252,14 @@ module Google
254
252
  # # Call the get_operation method.
255
253
  # result = client.get_operation request
256
254
  #
257
- # # The returned object is of type Gapic::Operation. You can use this
258
- # # object to check the status of an operation, cancel it, or wait
259
- # # for results. Here is how to block until completion:
255
+ # # The returned object is of type Gapic::Operation. You can use it to
256
+ # # check the status of an operation, cancel it, or wait for results.
257
+ # # Here is how to wait for a response.
260
258
  # result.wait_until_done! timeout: 60
261
259
  # if result.response?
262
260
  # p result.response
263
261
  # else
264
- # puts "Error!"
262
+ # puts "No response received."
265
263
  # end
266
264
  #
267
265
  def get_operation request, options = nil
@@ -541,14 +539,14 @@ module Google
541
539
  # # Call the wait_operation method.
542
540
  # result = client.wait_operation request
543
541
  #
544
- # # The returned object is of type Gapic::Operation. You can use this
545
- # # object to check the status of an operation, cancel it, or wait
546
- # # for results. Here is how to block until completion:
542
+ # # The returned object is of type Gapic::Operation. You can use it to
543
+ # # check the status of an operation, cancel it, or wait for results.
544
+ # # Here is how to wait for a response.
547
545
  # result.wait_until_done! timeout: 60
548
546
  # if result.response?
549
547
  # p result.response
550
548
  # else
551
- # puts "Error!"
549
+ # puts "No response received."
552
550
  # end
553
551
  #
554
552
  def wait_operation request, options = nil
@@ -623,9 +621,9 @@ module Google
623
621
  # * (`String`) The path to a service account key file in JSON format
624
622
  # * (`Hash`) A service account key as a Hash
625
623
  # * (`Google::Auth::Credentials`) A googleauth credentials object
626
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
624
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
627
625
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
628
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
626
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
629
627
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
630
628
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
631
629
  # * (`nil`) indicating no credentials
@@ -39,7 +39,7 @@ module Google
39
39
  # Provides access to the table schemas only, not the data stored within
40
40
  # the tables.
41
41
  #
42
- # To load this service and instantiate a client:
42
+ # @example Load this service and instantiate a gRPC client
43
43
  #
44
44
  # require "google/cloud/bigtable/admin/v2/bigtable_table_admin"
45
45
  # client = ::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Client.new
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigtable
23
23
  module Admin
24
24
  module V2
25
- VERSION = "0.15.0"
25
+ VERSION = "0.16.0"
26
26
  end
27
27
  end
28
28
  end
@@ -25,9 +25,9 @@ module Google
25
25
  module Bigtable
26
26
  module Admin
27
27
  ##
28
- # To load this package, including all its services, and instantiate a client:
28
+ # API client module.
29
29
  #
30
- # @example
30
+ # @example Load this package, including all its services, and instantiate a gRPC client
31
31
  #
32
32
  # require "google/cloud/bigtable/admin/v2"
33
33
  # client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new