google-cloud-datastore-admin-v1 0.7.1 → 0.9.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: bb00f26d84bc5dac9f58ecee65ed2542c816eeff207565306eab922cb24ac1c7
4
- data.tar.gz: f74213092eda086c4f9df1d5eefc9415a4392c927d12fc9715a12f5cc934a5e3
3
+ metadata.gz: 66fb6d8c2be8c1f60d5b584bc5cada3619b1767f85f94147700ab05b72a2289d
4
+ data.tar.gz: 4b15bc47177070078eed82c88f31f4e051e63a8971982bdc5da417c103cc2b23
5
5
  SHA512:
6
- metadata.gz: adfb0734e2c661608ad360816237382c9c1eafd3b7100073e06e935a53a51899387fcb4db3f295a0d8bd33d146ba7365093d6fe2dac67fdf64e7215fdc0d1d8e
7
- data.tar.gz: 3c2a65f7ae98586301066beb80a02d95e06bf1c503ce7a43a9ed4e55091f47db99686e7652c1cf439e45890e3277349c33a9503d5e95bff00d4065c47b8cedc1
6
+ metadata.gz: 6982ddea912ac8f7985fb1021d002b39c3a60fd5fc9ebaa28e3beab3d6b8136b24a1accbd79775b6ba80a103e484f9c1c04b04f13de03aee72f3401603dfa9e7
7
+ data.tar.gz: 335094af429801b0a71310a762ede2b6fcaabc8a7fc78764bf65b786dcb44a5f404b11f0288bc1d5a14863783f32fcee0280d7a524928b1e487d03bc9988de5c
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Ruby Client for the Firestore in Datastore mode Admin V1 API
2
2
 
3
- API Client library for the Firestore in Datastore mode Admin V1 API
3
+ Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.
4
4
 
5
5
  Firestore in Datastore mode is a NoSQL document database built for automatic scaling, high performance, and ease of application development.
6
6
 
@@ -47,7 +47,7 @@ for general usage information.
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
49
  The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
50
+ or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
53
 
@@ -200,7 +200,7 @@ module Google
200
200
  credentials = @config.credentials
201
201
  # Use self-signed JWT if the endpoint is unchanged from default,
202
202
  # but only if the default endpoint does not have a region prefix.
203
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
203
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
204
204
  !@config.endpoint.split(".").first.include?("-")
205
205
  credentials ||= Credentials.default scope: @config.scope,
206
206
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -305,14 +305,14 @@ module Google
305
305
  # # Call the export_entities method.
306
306
  # result = client.export_entities request
307
307
  #
308
- # # The returned object is of type Gapic::Operation. You can use this
309
- # # object to check the status of an operation, cancel it, or wait
310
- # # for results. Here is how to block until completion:
308
+ # # The returned object is of type Gapic::Operation. You can use it to
309
+ # # check the status of an operation, cancel it, or wait for results.
310
+ # # Here is how to wait for a response.
311
311
  # result.wait_until_done! timeout: 60
312
312
  # if result.response?
313
313
  # p result.response
314
314
  # else
315
- # puts "Error!"
315
+ # puts "No response received."
316
316
  # end
317
317
  #
318
318
  def export_entities request, options = nil
@@ -423,14 +423,14 @@ module Google
423
423
  # # Call the import_entities method.
424
424
  # result = client.import_entities request
425
425
  #
426
- # # The returned object is of type Gapic::Operation. You can use this
427
- # # object to check the status of an operation, cancel it, or wait
428
- # # for results. Here is how to block until completion:
426
+ # # The returned object is of type Gapic::Operation. You can use it to
427
+ # # check the status of an operation, cancel it, or wait for results.
428
+ # # Here is how to wait for a response.
429
429
  # result.wait_until_done! timeout: 60
430
430
  # if result.response?
431
431
  # p result.response
432
432
  # else
433
- # puts "Error!"
433
+ # puts "No response received."
434
434
  # end
435
435
  #
436
436
  def import_entities request, options = nil
@@ -532,14 +532,14 @@ module Google
532
532
  # # Call the create_index method.
533
533
  # result = client.create_index request
534
534
  #
535
- # # The returned object is of type Gapic::Operation. You can use this
536
- # # object to check the status of an operation, cancel it, or wait
537
- # # for results. Here is how to block until completion:
535
+ # # The returned object is of type Gapic::Operation. You can use it to
536
+ # # check the status of an operation, cancel it, or wait for results.
537
+ # # Here is how to wait for a response.
538
538
  # result.wait_until_done! timeout: 60
539
539
  # if result.response?
540
540
  # p result.response
541
541
  # else
542
- # puts "Error!"
542
+ # puts "No response received."
543
543
  # end
544
544
  #
545
545
  def create_index request, options = nil
@@ -636,14 +636,14 @@ module Google
636
636
  # # Call the delete_index method.
637
637
  # result = client.delete_index request
638
638
  #
639
- # # The returned object is of type Gapic::Operation. You can use this
640
- # # object to check the status of an operation, cancel it, or wait
641
- # # for results. Here is how to block until completion:
639
+ # # The returned object is of type Gapic::Operation. You can use it to
640
+ # # check the status of an operation, cancel it, or wait for results.
641
+ # # Here is how to wait for a response.
642
642
  # result.wait_until_done! timeout: 60
643
643
  # if result.response?
644
644
  # p result.response
645
645
  # else
646
- # puts "Error!"
646
+ # puts "No response received."
647
647
  # end
648
648
  #
649
649
  def delete_index request, options = nil
@@ -830,13 +830,11 @@ module Google
830
830
  # # Call the list_indexes method.
831
831
  # result = client.list_indexes request
832
832
  #
833
- # # The returned object is of type Gapic::PagedEnumerable. You can
834
- # # iterate over all elements by calling #each, and the enumerable
835
- # # will lazily make API calls to fetch subsequent pages. Other
836
- # # methods are also available for managing paging directly.
837
- # result.each do |response|
833
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
834
+ # # over elements, and API calls will be issued to fetch pages as needed.
835
+ # result.each do |item|
838
836
  # # Each element is of type ::Google::Cloud::Datastore::Admin::V1::Index.
839
- # p response
837
+ # p item
840
838
  # end
841
839
  #
842
840
  def list_indexes request, options = nil
@@ -919,9 +917,9 @@ module Google
919
917
  # * (`String`) The path to a service account key file in JSON format
920
918
  # * (`Hash`) A service account key as a Hash
921
919
  # * (`Google::Auth::Credentials`) A googleauth credentials object
922
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
920
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
923
921
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
924
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
922
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
925
923
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
926
924
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
927
925
  # * (`nil`) indicating no credentials
@@ -963,7 +961,9 @@ module Google
963
961
  class Configuration
964
962
  extend ::Gapic::Config
965
963
 
966
- config_attr :endpoint, "datastore.googleapis.com", ::String
964
+ DEFAULT_ENDPOINT = "datastore.googleapis.com"
965
+
966
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
967
967
  config_attr :credentials, nil do |value|
968
968
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
969
969
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -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
@@ -667,7 +665,9 @@ module Google
667
665
  class Configuration
668
666
  extend ::Gapic::Config
669
667
 
670
- config_attr :endpoint, "datastore.googleapis.com", ::String
668
+ DEFAULT_ENDPOINT = "datastore.googleapis.com"
669
+
670
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
671
671
  config_attr :credentials, nil do |value|
672
672
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
673
673
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC