google-cloud-domains-v1 0.2.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e0848a3d6b1de24998491ed4e902ae721ee450fe35e981d49ce769ed23a31870
4
- data.tar.gz: a3867a2c802bc0cbb2d45d5e75823f9465d340a4b861c303146c479b040f95c5
3
+ metadata.gz: 9c5ce31dcacfca8c04dbd3b0dae145bd0aec721b40e6a40590f76e9d2343e420
4
+ data.tar.gz: 7d39583f07b20898b9766c24f7963b43f9c7b39669c86939e6e16cb865d17245
5
5
  SHA512:
6
- metadata.gz: 1d4caa0f8f64fe7f0222e1fabd04c33e4ba50a39753c3034201980e55c1d1d3a9059929b3e0dc81456a81798b10c1d836dec1a8acde82c6ffc7aaaaa77262cba
7
- data.tar.gz: 83ba5e0d09182e9ebde0d1e1f7bcee7605604ad37b08a00b7a971ae87d8a3b709eb9fe601d82f8f69e143ec96e0b1a6f54454713cc744d6a3d7d84ded9fd19de
6
+ metadata.gz: 9fa845c3d059dddf6bfd4a1c827fe0e4655ad42e40b2b1231efa594f5137b849c60789dbe717d8782bbf66d3bcca114abf47808b9d2a6571396ced30c2271a5b
7
+ data.tar.gz: c14638c24c4706bb5f2104205631aaefd1e0733d18b5103e88d2c39b31da621156b65905ac27c60a3f481a38b0129bb095093f606dd80721aae31938056fa2a3
data/AUTHENTICATION.md CHANGED
@@ -114,7 +114,7 @@ credentials are discovered.
114
114
  To configure your system for this, simply:
115
115
 
116
116
  1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth login`
117
+ 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
118
  3. Write code as if already authenticated.
119
119
 
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Ruby Client for the Cloud Domains V1 API
2
2
 
3
- API Client library for the Cloud Domains V1 API
3
+ Enables management and configuration of domain names.
4
4
 
5
5
  The Cloud Domains API provides registration, management and configuration of domain names.
6
6
 
@@ -46,8 +46,8 @@ for general usage information.
46
46
  ## Enabling Logging
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
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
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://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
 
@@ -123,7 +123,7 @@ module Google
123
123
  credentials = @config.credentials
124
124
  # Use self-signed JWT if the endpoint is unchanged from default,
125
125
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
126
+ enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
127
  !@config.endpoint.split(".").first.include?("-")
128
128
  credentials ||= Credentials.default scope: @config.scope,
129
129
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -407,14 +407,14 @@ module Google
407
407
  # # Call the register_domain method.
408
408
  # result = client.register_domain request
409
409
  #
410
- # # The returned object is of type Gapic::Operation. You can use this
411
- # # object to check the status of an operation, cancel it, or wait
412
- # # for results. Here is how to block until completion:
410
+ # # The returned object is of type Gapic::Operation. You can use it to
411
+ # # check the status of an operation, cancel it, or wait for results.
412
+ # # Here is how to wait for a response.
413
413
  # result.wait_until_done! timeout: 60
414
414
  # if result.response?
415
415
  # p result.response
416
416
  # else
417
- # puts "Error!"
417
+ # puts "No response received."
418
418
  # end
419
419
  #
420
420
  def register_domain request, options = nil
@@ -634,14 +634,14 @@ module Google
634
634
  # # Call the transfer_domain method.
635
635
  # result = client.transfer_domain request
636
636
  #
637
- # # The returned object is of type Gapic::Operation. You can use this
638
- # # object to check the status of an operation, cancel it, or wait
639
- # # for results. Here is how to block until completion:
637
+ # # The returned object is of type Gapic::Operation. You can use it to
638
+ # # check the status of an operation, cancel it, or wait for results.
639
+ # # Here is how to wait for a response.
640
640
  # result.wait_until_done! timeout: 60
641
641
  # if result.response?
642
642
  # p result.response
643
643
  # else
644
- # puts "Error!"
644
+ # puts "No response received."
645
645
  # end
646
646
  #
647
647
  def transfer_domain request, options = nil
@@ -750,13 +750,11 @@ module Google
750
750
  # # Call the list_registrations method.
751
751
  # result = client.list_registrations request
752
752
  #
753
- # # The returned object is of type Gapic::PagedEnumerable. You can
754
- # # iterate over all elements by calling #each, and the enumerable
755
- # # will lazily make API calls to fetch subsequent pages. Other
756
- # # methods are also available for managing paging directly.
757
- # result.each do |response|
753
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
754
+ # # over elements, and API calls will be issued to fetch pages as needed.
755
+ # result.each do |item|
758
756
  # # Each element is of type ::Google::Cloud::Domains::V1::Registration.
759
- # p response
757
+ # p item
760
758
  # end
761
759
  #
762
760
  def list_registrations request, options = nil
@@ -937,14 +935,14 @@ module Google
937
935
  # # Call the update_registration method.
938
936
  # result = client.update_registration request
939
937
  #
940
- # # The returned object is of type Gapic::Operation. You can use this
941
- # # object to check the status of an operation, cancel it, or wait
942
- # # for results. Here is how to block until completion:
938
+ # # The returned object is of type Gapic::Operation. You can use it to
939
+ # # check the status of an operation, cancel it, or wait for results.
940
+ # # Here is how to wait for a response.
943
941
  # result.wait_until_done! timeout: 60
944
942
  # if result.response?
945
943
  # p result.response
946
944
  # else
947
- # puts "Error!"
945
+ # puts "No response received."
948
946
  # end
949
947
  #
950
948
  def update_registration request, options = nil
@@ -1037,14 +1035,14 @@ module Google
1037
1035
  # # Call the configure_management_settings method.
1038
1036
  # result = client.configure_management_settings request
1039
1037
  #
1040
- # # The returned object is of type Gapic::Operation. You can use this
1041
- # # object to check the status of an operation, cancel it, or wait
1042
- # # for results. Here is how to block until completion:
1038
+ # # The returned object is of type Gapic::Operation. You can use it to
1039
+ # # check the status of an operation, cancel it, or wait for results.
1040
+ # # Here is how to wait for a response.
1043
1041
  # result.wait_until_done! timeout: 60
1044
1042
  # if result.response?
1045
1043
  # p result.response
1046
1044
  # else
1047
- # puts "Error!"
1045
+ # puts "No response received."
1048
1046
  # end
1049
1047
  #
1050
1048
  def configure_management_settings request, options = nil
@@ -1145,14 +1143,14 @@ module Google
1145
1143
  # # Call the configure_dns_settings method.
1146
1144
  # result = client.configure_dns_settings request
1147
1145
  #
1148
- # # The returned object is of type Gapic::Operation. You can use this
1149
- # # object to check the status of an operation, cancel it, or wait
1150
- # # for results. Here is how to block until completion:
1146
+ # # The returned object is of type Gapic::Operation. You can use it to
1147
+ # # check the status of an operation, cancel it, or wait for results.
1148
+ # # Here is how to wait for a response.
1151
1149
  # result.wait_until_done! timeout: 60
1152
1150
  # if result.response?
1153
1151
  # p result.response
1154
1152
  # else
1155
- # puts "Error!"
1153
+ # puts "No response received."
1156
1154
  # end
1157
1155
  #
1158
1156
  def configure_dns_settings request, options = nil
@@ -1251,14 +1249,14 @@ module Google
1251
1249
  # # Call the configure_contact_settings method.
1252
1250
  # result = client.configure_contact_settings request
1253
1251
  #
1254
- # # The returned object is of type Gapic::Operation. You can use this
1255
- # # object to check the status of an operation, cancel it, or wait
1256
- # # for results. Here is how to block until completion:
1252
+ # # The returned object is of type Gapic::Operation. You can use it to
1253
+ # # check the status of an operation, cancel it, or wait for results.
1254
+ # # Here is how to wait for a response.
1257
1255
  # result.wait_until_done! timeout: 60
1258
1256
  # if result.response?
1259
1257
  # p result.response
1260
1258
  # else
1261
- # puts "Error!"
1259
+ # puts "No response received."
1262
1260
  # end
1263
1261
  #
1264
1262
  def configure_contact_settings request, options = nil
@@ -1353,14 +1351,14 @@ module Google
1353
1351
  # # Call the export_registration method.
1354
1352
  # result = client.export_registration request
1355
1353
  #
1356
- # # The returned object is of type Gapic::Operation. You can use this
1357
- # # object to check the status of an operation, cancel it, or wait
1358
- # # for results. Here is how to block until completion:
1354
+ # # The returned object is of type Gapic::Operation. You can use it to
1355
+ # # check the status of an operation, cancel it, or wait for results.
1356
+ # # Here is how to wait for a response.
1359
1357
  # result.wait_until_done! timeout: 60
1360
1358
  # if result.response?
1361
1359
  # p result.response
1362
1360
  # else
1363
- # puts "Error!"
1361
+ # puts "No response received."
1364
1362
  # end
1365
1363
  #
1366
1364
  def export_registration request, options = nil
@@ -1465,14 +1463,14 @@ module Google
1465
1463
  # # Call the delete_registration method.
1466
1464
  # result = client.delete_registration request
1467
1465
  #
1468
- # # The returned object is of type Gapic::Operation. You can use this
1469
- # # object to check the status of an operation, cancel it, or wait
1470
- # # for results. Here is how to block until completion:
1466
+ # # The returned object is of type Gapic::Operation. You can use it to
1467
+ # # check the status of an operation, cancel it, or wait for results.
1468
+ # # Here is how to wait for a response.
1471
1469
  # result.wait_until_done! timeout: 60
1472
1470
  # if result.response?
1473
1471
  # p result.response
1474
1472
  # else
1475
- # puts "Error!"
1473
+ # puts "No response received."
1476
1474
  # end
1477
1475
  #
1478
1476
  def delete_registration request, options = nil
@@ -1734,9 +1732,9 @@ module Google
1734
1732
  # * (`String`) The path to a service account key file in JSON format
1735
1733
  # * (`Hash`) A service account key as a Hash
1736
1734
  # * (`Google::Auth::Credentials`) A googleauth credentials object
1737
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
1735
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
1738
1736
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
1739
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
1737
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
1740
1738
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
1741
1739
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
1742
1740
  # * (`nil`) indicating no credentials
@@ -1778,7 +1776,9 @@ module Google
1778
1776
  class Configuration
1779
1777
  extend ::Gapic::Config
1780
1778
 
1781
- config_attr :endpoint, "domains.googleapis.com", ::String
1779
+ DEFAULT_ENDPOINT = "domains.googleapis.com"
1780
+
1781
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1782
1782
  config_attr :credentials, nil do |value|
1783
1783
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1784
1784
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -158,13 +158,11 @@ module Google
158
158
  # # Call the list_operations method.
159
159
  # result = client.list_operations request
160
160
  #
161
- # # The returned object is of type Gapic::PagedEnumerable. You can
162
- # # iterate over all elements by calling #each, and the enumerable
163
- # # will lazily make API calls to fetch subsequent pages. Other
164
- # # methods are also available for managing paging directly.
165
- # result.each do |response|
161
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
162
+ # # over elements, and API calls will be issued to fetch pages as needed.
163
+ # result.each do |item|
166
164
  # # Each element is of type ::Google::Longrunning::Operation.
167
- # p response
165
+ # p item
168
166
  # end
169
167
  #
170
168
  def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
253
251
  # # Call the get_operation method.
254
252
  # result = client.get_operation request
255
253
  #
256
- # # The returned object is of type Gapic::Operation. You can use this
257
- # # object to check the status of an operation, cancel it, or wait
258
- # # for results. Here is how to block until completion:
254
+ # # The returned object is of type Gapic::Operation. You can use it to
255
+ # # check the status of an operation, cancel it, or wait for results.
256
+ # # Here is how to wait for a response.
259
257
  # result.wait_until_done! timeout: 60
260
258
  # if result.response?
261
259
  # p result.response
262
260
  # else
263
- # puts "Error!"
261
+ # puts "No response received."
264
262
  # end
265
263
  #
266
264
  def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
540
538
  # # Call the wait_operation method.
541
539
  # result = client.wait_operation request
542
540
  #
543
- # # The returned object is of type Gapic::Operation. You can use this
544
- # # object to check the status of an operation, cancel it, or wait
545
- # # for results. Here is how to block until completion:
541
+ # # The returned object is of type Gapic::Operation. You can use it to
542
+ # # check the status of an operation, cancel it, or wait for results.
543
+ # # Here is how to wait for a response.
546
544
  # result.wait_until_done! timeout: 60
547
545
  # if result.response?
548
546
  # p result.response
549
547
  # else
550
- # puts "Error!"
548
+ # puts "No response received."
551
549
  # end
552
550
  #
553
551
  def wait_operation request, options = nil
@@ -622,9 +620,9 @@ module Google
622
620
  # * (`String`) The path to a service account key file in JSON format
623
621
  # * (`Hash`) A service account key as a Hash
624
622
  # * (`Google::Auth::Credentials`) A googleauth credentials object
625
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
623
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
626
624
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
627
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
625
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
628
626
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
629
627
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
630
628
  # * (`nil`) indicating no credentials
@@ -666,7 +664,9 @@ module Google
666
664
  class Configuration
667
665
  extend ::Gapic::Config
668
666
 
669
- config_attr :endpoint, "domains.googleapis.com", ::String
667
+ DEFAULT_ENDPOINT = "domains.googleapis.com"
668
+
669
+ config_attr :endpoint, DEFAULT_ENDPOINT, ::String
670
670
  config_attr :credentials, nil do |value|
671
671
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
672
672
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC