google-cloud-domains-v1 0.4.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/domains/v1/domains/client.rb +42 -9
  4. data/lib/google/cloud/domains/v1/domains/operations.rb +38 -7
  5. data/lib/google/cloud/domains/v1/domains/rest/client.rb +334 -7
  6. data/lib/google/cloud/domains/v1/domains/rest/operations.rb +108 -8
  7. data/lib/google/cloud/domains/v1/domains/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/domains/v1/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +14 -0
  10. data/proto_docs/google/api/field_behavior.rb +14 -0
  11. metadata +5 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9c5ce31dcacfca8c04dbd3b0dae145bd0aec721b40e6a40590f76e9d2343e420
4
- data.tar.gz: 7d39583f07b20898b9766c24f7963b43f9c7b39669c86939e6e16cb865d17245
3
+ metadata.gz: 2a9878d2b7ab4adae9bccfd750864eae51b1c55064b312a2b20d8a346ae5872e
4
+ data.tar.gz: d3bb43d0f160746cb761460da7e11047e70892c9dd32c50e65aec781757d2c76
5
5
  SHA512:
6
- metadata.gz: 9fa845c3d059dddf6bfd4a1c827fe0e4655ad42e40b2b1231efa594f5137b849c60789dbe717d8782bbf66d3bcca114abf47808b9d2a6571396ced30c2271a5b
7
- data.tar.gz: c14638c24c4706bb5f2104205631aaefd1e0733d18b5103e88d2c39b31da621156b65905ac27c60a3f481a38b0129bb095093f606dd80721aae31938056fa2a3
6
+ metadata.gz: 947b24fae825ea288e54706aa555bec8003dec6c321ec01e280b66b04c79b384b059979b9bf4a30cac76683c889134701afa5b7e0b0255020ef3133a9e6ef59c
7
+ data.tar.gz: 3692f277bc7c75bd7d0069367ba2b67da9244979bcdbf7334bbcc92a62be8aa01ded7bf3bfa66329db885bd6eefec1bd3bd1968319c8ec43f2bb001b6a8932be
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-domains-v1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
6
- [Google Cloud Platform environments](#google-cloud-platform-environments) the
7
- credentials will be discovered automatically. When running on other
8
- environments, the Service Account credentials can be specified by providing the
9
- path to the
10
- [JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
11
- for the account (or the JSON itself) in
12
- [environment variables](#environment-variables). Additionally, Cloud SDK
13
- credentials can also be discovered automatically, but this is only recommended
14
- during development.
3
+ The recommended way to authenticate to the google-cloud-domains-v1 library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
15
6
 
16
7
  ## Quickstart
17
8
 
18
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export DOMAINS_CREDENTIALS=path/to/keyfile.json
23
- ```
24
-
25
- 3. Initialize the client.
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
26
14
 
27
- ```ruby
28
- require "google/cloud/domains/v1"
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
29
17
 
30
- client = ::Google::Cloud::Domains::V1::Domains::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-domains-v1 library aims to make authentication
36
- as simple as possible, and provides several mechanisms to configure your system
37
- without requiring **Service Account Credentials** directly in code.
38
-
39
- **Credentials** are discovered in the following order:
40
-
41
- 1. Specify credentials in method arguments
42
- 2. Specify credentials in configuration
43
- 3. Discover credentials path in environment variables
44
- 4. Discover credentials JSON in environment variables
45
- 5. Discover credentials file in the Cloud SDK's path
46
- 6. Discover GCP credentials
47
-
48
- ### Google Cloud Platform environments
22
+ 3. Write code as if already authenticated.
49
23
 
50
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
52
- Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
53
- Code should be written as if already authenticated.
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
54
26
 
55
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
61
- **Credentials JSON** file can be stored in the environment variable, or the
62
- **Credentials JSON** itself can be stored for environments such as Docker
63
- containers where writing files is difficult or not encouraged.
29
+ The google-cloud-domains-v1 library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
64
33
 
65
- The environment variables that google-cloud-domains-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Domains::V1::Domains::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `DOMAINS_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `DOMAINS_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
72
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
73
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
74
41
 
75
- ```ruby
76
- require "google/cloud/domains/v1"
77
-
78
- ENV["DOMAINS_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Domains::V1::Domains::Client.new
81
- ```
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
82
49
 
83
- ### Configuration
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
84
53
 
85
- The path to the **Credentials JSON** file can be configured instead of storing
86
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
87
55
 
88
56
  ```ruby
89
57
  require "google/cloud/domains/v1"
90
58
 
91
59
  client = ::Google::Cloud::Domains::V1::Domains::Client.new do |config|
92
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
93
61
  end
94
62
  ```
95
63
 
96
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
97
65
 
98
66
  ```ruby
99
67
  require "google/cloud/domains/v1"
100
68
 
101
69
  ::Google::Cloud::Domains::V1::Domains::Client.configure do |config|
102
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
103
71
  end
104
72
 
105
73
  client = ::Google::Cloud::Domains::V1::Domains::Client.new
106
74
  ```
107
75
 
108
- ### Cloud SDK
76
+ ### Environment Variables
109
77
 
110
- This option allows for an easy way to authenticate during development. If
111
- credentials are not provided in code or in environment variables, then Cloud SDK
112
- credentials are discovered.
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
113
82
 
114
- To configure your system for this, simply:
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
115
87
 
116
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
117
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
118
- 3. Write code as if already authenticated.
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-domains-v1
93
+ checks for credentials are:
119
94
 
120
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
122
97
 
123
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/domains/v1"
124
100
 
125
- Google Cloud requires **Service Account Credentials** to
126
- connect to the APIs. You will use the **JSON key file** to
127
- connect to most services with google-cloud-domains-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
128
102
 
129
- If you are not running this client within
130
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
131
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Domains::V1::Domains::Client.new
104
+ ```
132
105
 
133
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
134
- 2. Create a new project or click on an existing project.
135
- 3. Activate the menu in the upper left and select **APIs & Services**. From
136
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
137
107
 
138
- *Note: You may need to enable billing in order to use these services.*
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
139
111
 
140
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
141
113
 
142
- Find the "Create credentials" drop down near the top of the page, and select
143
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
144
115
 
145
- If you want to re-use an existing service account, you can easily generate a
146
- new key file. Just select the account you wish to re-use, click the pencil
147
- tool on the right side to edit the service account, select the **Keys** tab,
148
- and then select **Add Key**.
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
149
120
 
150
- The key file you download will be used by this library to authenticate API
151
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/lib/google/cloud/domains/v1/domains/client.rb CHANGED
@@ -30,6 +30,9 @@ module Google
30
30
  # The Cloud Domains API enables management and configuration of domain names.
31
31
  #
32
32
  class Client
33
+ # @private
34
+ DEFAULT_ENDPOINT_TEMPLATE = "domains.$UNIVERSE_DOMAIN$"
35
+
33
36
  include Paths
34
37
 
35
38
  # @private
@@ -90,6 +93,15 @@ module Google
90
93
  @config
91
94
  end
92
95
 
96
+ ##
97
+ # The effective universe domain
98
+ #
99
+ # @return [String]
100
+ #
101
+ def universe_domain
102
+ @domains_stub.universe_domain
103
+ end
104
+
93
105
  ##
94
106
  # Create a new Domains client object.
95
107
  #
@@ -123,8 +135,9 @@ module Google
123
135
  credentials = @config.credentials
124
136
  # Use self-signed JWT if the endpoint is unchanged from default,
125
137
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
- !@config.endpoint.split(".").first.include?("-")
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
128
141
  credentials ||= Credentials.default scope: @config.scope,
129
142
  enable_self_signed_jwt: enable_self_signed_jwt
130
143
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -137,14 +150,18 @@ module Google
137
150
  config.credentials = credentials
138
151
  config.quota_project = @quota_project_id
139
152
  config.endpoint = @config.endpoint
153
+ config.universe_domain = @config.universe_domain
140
154
  end
141
155
 
142
156
  @domains_stub = ::Gapic::ServiceStub.new(
143
157
  ::Google::Cloud::Domains::V1::Domains::Stub,
144
- credentials: credentials,
145
- endpoint: @config.endpoint,
158
+ credentials: credentials,
159
+ endpoint: @config.endpoint,
160
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
161
+ universe_domain: @config.universe_domain,
146
162
  channel_args: @config.channel_args,
147
- interceptors: @config.interceptors
163
+ interceptors: @config.interceptors,
164
+ channel_pool_config: @config.channel_pool
148
165
  )
149
166
  end
150
167
 
@@ -1724,9 +1741,9 @@ module Google
1724
1741
  # end
1725
1742
  #
1726
1743
  # @!attribute [rw] endpoint
1727
- # The hostname or hostname:port of the service endpoint.
1728
- # Defaults to `"domains.googleapis.com"`.
1729
- # @return [::String]
1744
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1745
+ # nil, indicating to use the default endpoint in the current universe domain.
1746
+ # @return [::String,nil]
1730
1747
  # @!attribute [rw] credentials
1731
1748
  # Credentials to send with calls. You may provide any of the following types:
1732
1749
  # * (`String`) The path to a service account key file in JSON format
@@ -1772,13 +1789,20 @@ module Google
1772
1789
  # @!attribute [rw] quota_project
1773
1790
  # A separate project against which to charge quota.
1774
1791
  # @return [::String]
1792
+ # @!attribute [rw] universe_domain
1793
+ # The universe domain within which to make requests. This determines the
1794
+ # default endpoint URL. The default value of nil uses the environment
1795
+ # universe (usually the default "googleapis.com" universe).
1796
+ # @return [::String,nil]
1775
1797
  #
1776
1798
  class Configuration
1777
1799
  extend ::Gapic::Config
1778
1800
 
1801
+ # @private
1802
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1779
1803
  DEFAULT_ENDPOINT = "domains.googleapis.com"
1780
1804
 
1781
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1805
+ config_attr :endpoint, nil, ::String, nil
1782
1806
  config_attr :credentials, nil do |value|
1783
1807
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1784
1808
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1793,6 +1817,7 @@ module Google
1793
1817
  config_attr :metadata, nil, ::Hash, nil
1794
1818
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1795
1819
  config_attr :quota_project, nil, ::String, nil
1820
+ config_attr :universe_domain, nil, ::String, nil
1796
1821
 
1797
1822
  # @private
1798
1823
  def initialize parent_config = nil
@@ -1813,6 +1838,14 @@ module Google
1813
1838
  end
1814
1839
  end
1815
1840
 
1841
+ ##
1842
+ # Configuration for the channel pool
1843
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
1844
+ #
1845
+ def channel_pool
1846
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
1847
+ end
1848
+
1816
1849
  ##
1817
1850
  # Configuration RPC class for the Domains API.
1818
1851
  #
data/lib/google/cloud/domains/v1/domains/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module Domains
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "domains.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -90,10 +102,13 @@ module Google
90
102
 
91
103
  @operations_stub = ::Gapic::ServiceStub.new(
92
104
  ::Google::Longrunning::Operations::Stub,
93
- credentials: credentials,
94
- endpoint: @config.endpoint,
105
+ credentials: credentials,
106
+ endpoint: @config.endpoint,
107
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
108
+ universe_domain: @config.universe_domain,
95
109
  channel_args: @config.channel_args,
96
- interceptors: @config.interceptors
110
+ interceptors: @config.interceptors,
111
+ channel_pool_config: @config.channel_pool
97
112
  )
98
113
 
99
114
  # Used by an LRO wrapper for some methods of this service
@@ -612,9 +627,9 @@ module Google
612
627
  # end
613
628
  #
614
629
  # @!attribute [rw] endpoint
615
- # The hostname or hostname:port of the service endpoint.
616
- # Defaults to `"domains.googleapis.com"`.
617
- # @return [::String]
630
+ # A custom service endpoint, as a hostname or hostname:port. The default is
631
+ # nil, indicating to use the default endpoint in the current universe domain.
632
+ # @return [::String,nil]
618
633
  # @!attribute [rw] credentials
619
634
  # Credentials to send with calls. You may provide any of the following types:
620
635
  # * (`String`) The path to a service account key file in JSON format
@@ -660,13 +675,20 @@ module Google
660
675
  # @!attribute [rw] quota_project
661
676
  # A separate project against which to charge quota.
662
677
  # @return [::String]
678
+ # @!attribute [rw] universe_domain
679
+ # The universe domain within which to make requests. This determines the
680
+ # default endpoint URL. The default value of nil uses the environment
681
+ # universe (usually the default "googleapis.com" universe).
682
+ # @return [::String,nil]
663
683
  #
664
684
  class Configuration
665
685
  extend ::Gapic::Config
666
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
667
689
  DEFAULT_ENDPOINT = "domains.googleapis.com"
668
690
 
669
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
670
692
  config_attr :credentials, nil do |value|
671
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
672
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -681,6 +703,7 @@ module Google
681
703
  config_attr :metadata, nil, ::Hash, nil
682
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
683
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
684
707
 
685
708
  # @private
686
709
  def initialize parent_config = nil
@@ -701,6 +724,14 @@ module Google
701
724
  end
702
725
  end
703
726
 
727
+ ##
728
+ # Configuration for the channel pool
729
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
730
+ #
731
+ def channel_pool
732
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
733
+ end
734
+
704
735
  ##
705
736
  # Configuration RPC class for the Operations API.
706
737
  #
data/lib/google/cloud/domains/v1/domains/rest/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # The Cloud Domains API enables management and configuration of domain names.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "domains.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -92,6 +95,15 @@ module Google
92
95
  @config
93
96
  end
94
97
 
98
+ ##
99
+ # The effective universe domain
100
+ #
101
+ # @return [String]
102
+ #
103
+ def universe_domain
104
+ @domains_stub.universe_domain
105
+ end
106
+
95
107
  ##
96
108
  # Create a new Domains REST client object.
97
109
  #
@@ -119,8 +131,9 @@ module Google
119
131
  credentials = @config.credentials
120
132
  # Use self-signed JWT if the endpoint is unchanged from default,
121
133
  # but only if the default endpoint does not have a region prefix.
122
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
123
- !@config.endpoint.split(".").first.include?("-")
134
+ enable_self_signed_jwt = @config.endpoint.nil? ||
135
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
136
+ !@config.endpoint.split(".").first.include?("-"))
124
137
  credentials ||= Credentials.default scope: @config.scope,
125
138
  enable_self_signed_jwt: enable_self_signed_jwt
126
139
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -134,9 +147,15 @@ module Google
134
147
  config.credentials = credentials
135
148
  config.quota_project = @quota_project_id
136
149
  config.endpoint = @config.endpoint
150
+ config.universe_domain = @config.universe_domain
137
151
  end
138
152
 
139
- @domains_stub = ::Google::Cloud::Domains::V1::Domains::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
153
+ @domains_stub = ::Google::Cloud::Domains::V1::Domains::Rest::ServiceStub.new(
154
+ endpoint: @config.endpoint,
155
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
156
+ universe_domain: @config.universe_domain,
157
+ credentials: credentials
158
+ )
140
159
  end
141
160
 
142
161
  ##
@@ -181,6 +200,22 @@ module Google
181
200
  # @return [::Google::Cloud::Domains::V1::SearchDomainsResponse]
182
201
  #
183
202
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
203
+ #
204
+ # @example Basic example
205
+ # require "google/cloud/domains/v1"
206
+ #
207
+ # # Create a client object. The client can be reused for multiple calls.
208
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
209
+ #
210
+ # # Create a request. To set request fields, pass in keyword arguments.
211
+ # request = Google::Cloud::Domains::V1::SearchDomainsRequest.new
212
+ #
213
+ # # Call the search_domains method.
214
+ # result = client.search_domains request
215
+ #
216
+ # # The returned object is of type Google::Cloud::Domains::V1::SearchDomainsResponse.
217
+ # p result
218
+ #
184
219
  def search_domains request, options = nil
185
220
  raise ::ArgumentError, "request must be provided" if request.nil?
186
221
 
@@ -246,6 +281,22 @@ module Google
246
281
  # @return [::Google::Cloud::Domains::V1::RetrieveRegisterParametersResponse]
247
282
  #
248
283
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
284
+ #
285
+ # @example Basic example
286
+ # require "google/cloud/domains/v1"
287
+ #
288
+ # # Create a client object. The client can be reused for multiple calls.
289
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
290
+ #
291
+ # # Create a request. To set request fields, pass in keyword arguments.
292
+ # request = Google::Cloud::Domains::V1::RetrieveRegisterParametersRequest.new
293
+ #
294
+ # # Call the retrieve_register_parameters method.
295
+ # result = client.retrieve_register_parameters request
296
+ #
297
+ # # The returned object is of type Google::Cloud::Domains::V1::RetrieveRegisterParametersResponse.
298
+ # p result
299
+ #
249
300
  def retrieve_register_parameters request, options = nil
250
301
  raise ::ArgumentError, "request must be provided" if request.nil?
251
302
 
@@ -338,6 +389,29 @@ module Google
338
389
  # @return [::Gapic::Operation]
339
390
  #
340
391
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
392
+ #
393
+ # @example Basic example
394
+ # require "google/cloud/domains/v1"
395
+ #
396
+ # # Create a client object. The client can be reused for multiple calls.
397
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
398
+ #
399
+ # # Create a request. To set request fields, pass in keyword arguments.
400
+ # request = Google::Cloud::Domains::V1::RegisterDomainRequest.new
401
+ #
402
+ # # Call the register_domain method.
403
+ # result = client.register_domain request
404
+ #
405
+ # # The returned object is of type Gapic::Operation. You can use it to
406
+ # # check the status of an operation, cancel it, or wait for results.
407
+ # # Here is how to wait for a response.
408
+ # result.wait_until_done! timeout: 60
409
+ # if result.response?
410
+ # p result.response
411
+ # else
412
+ # puts "No response received."
413
+ # end
414
+ #
341
415
  def register_domain request, options = nil
342
416
  raise ::ArgumentError, "request must be provided" if request.nil?
343
417
 
@@ -408,6 +482,22 @@ module Google
408
482
  # @return [::Google::Cloud::Domains::V1::RetrieveTransferParametersResponse]
409
483
  #
410
484
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
485
+ #
486
+ # @example Basic example
487
+ # require "google/cloud/domains/v1"
488
+ #
489
+ # # Create a client object. The client can be reused for multiple calls.
490
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
491
+ #
492
+ # # Create a request. To set request fields, pass in keyword arguments.
493
+ # request = Google::Cloud::Domains::V1::RetrieveTransferParametersRequest.new
494
+ #
495
+ # # Call the retrieve_transfer_parameters method.
496
+ # result = client.retrieve_transfer_parameters request
497
+ #
498
+ # # The returned object is of type Google::Cloud::Domains::V1::RetrieveTransferParametersResponse.
499
+ # p result
500
+ #
411
501
  def retrieve_transfer_parameters request, options = nil
412
502
  raise ::ArgumentError, "request must be provided" if request.nil?
413
503
 
@@ -512,6 +602,29 @@ module Google
512
602
  # @return [::Gapic::Operation]
513
603
  #
514
604
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
605
+ #
606
+ # @example Basic example
607
+ # require "google/cloud/domains/v1"
608
+ #
609
+ # # Create a client object. The client can be reused for multiple calls.
610
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
611
+ #
612
+ # # Create a request. To set request fields, pass in keyword arguments.
613
+ # request = Google::Cloud::Domains::V1::TransferDomainRequest.new
614
+ #
615
+ # # Call the transfer_domain method.
616
+ # result = client.transfer_domain request
617
+ #
618
+ # # The returned object is of type Gapic::Operation. You can use it to
619
+ # # check the status of an operation, cancel it, or wait for results.
620
+ # # Here is how to wait for a response.
621
+ # result.wait_until_done! timeout: 60
622
+ # if result.response?
623
+ # p result.response
624
+ # else
625
+ # puts "No response received."
626
+ # end
627
+ #
515
628
  def transfer_domain request, options = nil
516
629
  raise ::ArgumentError, "request must be provided" if request.nil?
517
630
 
@@ -598,6 +711,26 @@ module Google
598
711
  # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Domains::V1::Registration>]
599
712
  #
600
713
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
714
+ #
715
+ # @example Basic example
716
+ # require "google/cloud/domains/v1"
717
+ #
718
+ # # Create a client object. The client can be reused for multiple calls.
719
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
720
+ #
721
+ # # Create a request. To set request fields, pass in keyword arguments.
722
+ # request = Google::Cloud::Domains::V1::ListRegistrationsRequest.new
723
+ #
724
+ # # Call the list_registrations method.
725
+ # result = client.list_registrations request
726
+ #
727
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
728
+ # # over elements, and API calls will be issued to fetch pages as needed.
729
+ # result.each do |item|
730
+ # # Each element is of type ::Google::Cloud::Domains::V1::Registration.
731
+ # p item
732
+ # end
733
+ #
601
734
  def list_registrations request, options = nil
602
735
  raise ::ArgumentError, "request must be provided" if request.nil?
603
736
 
@@ -662,6 +795,22 @@ module Google
662
795
  # @return [::Google::Cloud::Domains::V1::Registration]
663
796
  #
664
797
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
798
+ #
799
+ # @example Basic example
800
+ # require "google/cloud/domains/v1"
801
+ #
802
+ # # Create a client object. The client can be reused for multiple calls.
803
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
804
+ #
805
+ # # Create a request. To set request fields, pass in keyword arguments.
806
+ # request = Google::Cloud::Domains::V1::GetRegistrationRequest.new
807
+ #
808
+ # # Call the get_registration method.
809
+ # result = client.get_registration request
810
+ #
811
+ # # The returned object is of type Google::Cloud::Domains::V1::Registration.
812
+ # p result
813
+ #
665
814
  def get_registration request, options = nil
666
815
  raise ::ArgumentError, "request must be provided" if request.nil?
667
816
 
@@ -733,6 +882,29 @@ module Google
733
882
  # @return [::Gapic::Operation]
734
883
  #
735
884
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
885
+ #
886
+ # @example Basic example
887
+ # require "google/cloud/domains/v1"
888
+ #
889
+ # # Create a client object. The client can be reused for multiple calls.
890
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
891
+ #
892
+ # # Create a request. To set request fields, pass in keyword arguments.
893
+ # request = Google::Cloud::Domains::V1::UpdateRegistrationRequest.new
894
+ #
895
+ # # Call the update_registration method.
896
+ # result = client.update_registration request
897
+ #
898
+ # # The returned object is of type Gapic::Operation. You can use it to
899
+ # # check the status of an operation, cancel it, or wait for results.
900
+ # # Here is how to wait for a response.
901
+ # result.wait_until_done! timeout: 60
902
+ # if result.response?
903
+ # p result.response
904
+ # else
905
+ # puts "No response received."
906
+ # end
907
+ #
736
908
  def update_registration request, options = nil
737
909
  raise ::ArgumentError, "request must be provided" if request.nil?
738
910
 
@@ -803,6 +975,29 @@ module Google
803
975
  # @return [::Gapic::Operation]
804
976
  #
805
977
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
978
+ #
979
+ # @example Basic example
980
+ # require "google/cloud/domains/v1"
981
+ #
982
+ # # Create a client object. The client can be reused for multiple calls.
983
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
984
+ #
985
+ # # Create a request. To set request fields, pass in keyword arguments.
986
+ # request = Google::Cloud::Domains::V1::ConfigureManagementSettingsRequest.new
987
+ #
988
+ # # Call the configure_management_settings method.
989
+ # result = client.configure_management_settings request
990
+ #
991
+ # # The returned object is of type Gapic::Operation. You can use it to
992
+ # # check the status of an operation, cancel it, or wait for results.
993
+ # # Here is how to wait for a response.
994
+ # result.wait_until_done! timeout: 60
995
+ # if result.response?
996
+ # p result.response
997
+ # else
998
+ # puts "No response received."
999
+ # end
1000
+ #
806
1001
  def configure_management_settings request, options = nil
807
1002
  raise ::ArgumentError, "request must be provided" if request.nil?
808
1003
 
@@ -881,6 +1076,29 @@ module Google
881
1076
  # @return [::Gapic::Operation]
882
1077
  #
883
1078
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1079
+ #
1080
+ # @example Basic example
1081
+ # require "google/cloud/domains/v1"
1082
+ #
1083
+ # # Create a client object. The client can be reused for multiple calls.
1084
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
1085
+ #
1086
+ # # Create a request. To set request fields, pass in keyword arguments.
1087
+ # request = Google::Cloud::Domains::V1::ConfigureDnsSettingsRequest.new
1088
+ #
1089
+ # # Call the configure_dns_settings method.
1090
+ # result = client.configure_dns_settings request
1091
+ #
1092
+ # # The returned object is of type Gapic::Operation. You can use it to
1093
+ # # check the status of an operation, cancel it, or wait for results.
1094
+ # # Here is how to wait for a response.
1095
+ # result.wait_until_done! timeout: 60
1096
+ # if result.response?
1097
+ # p result.response
1098
+ # else
1099
+ # puts "No response received."
1100
+ # end
1101
+ #
884
1102
  def configure_dns_settings request, options = nil
885
1103
  raise ::ArgumentError, "request must be provided" if request.nil?
886
1104
 
@@ -957,6 +1175,29 @@ module Google
957
1175
  # @return [::Gapic::Operation]
958
1176
  #
959
1177
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1178
+ #
1179
+ # @example Basic example
1180
+ # require "google/cloud/domains/v1"
1181
+ #
1182
+ # # Create a client object. The client can be reused for multiple calls.
1183
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
1184
+ #
1185
+ # # Create a request. To set request fields, pass in keyword arguments.
1186
+ # request = Google::Cloud::Domains::V1::ConfigureContactSettingsRequest.new
1187
+ #
1188
+ # # Call the configure_contact_settings method.
1189
+ # result = client.configure_contact_settings request
1190
+ #
1191
+ # # The returned object is of type Gapic::Operation. You can use it to
1192
+ # # check the status of an operation, cancel it, or wait for results.
1193
+ # # Here is how to wait for a response.
1194
+ # result.wait_until_done! timeout: 60
1195
+ # if result.response?
1196
+ # p result.response
1197
+ # else
1198
+ # puts "No response received."
1199
+ # end
1200
+ #
960
1201
  def configure_contact_settings request, options = nil
961
1202
  raise ::ArgumentError, "request must be provided" if request.nil?
962
1203
 
@@ -1029,6 +1270,29 @@ module Google
1029
1270
  # @return [::Gapic::Operation]
1030
1271
  #
1031
1272
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1273
+ #
1274
+ # @example Basic example
1275
+ # require "google/cloud/domains/v1"
1276
+ #
1277
+ # # Create a client object. The client can be reused for multiple calls.
1278
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
1279
+ #
1280
+ # # Create a request. To set request fields, pass in keyword arguments.
1281
+ # request = Google::Cloud::Domains::V1::ExportRegistrationRequest.new
1282
+ #
1283
+ # # Call the export_registration method.
1284
+ # result = client.export_registration request
1285
+ #
1286
+ # # The returned object is of type Gapic::Operation. You can use it to
1287
+ # # check the status of an operation, cancel it, or wait for results.
1288
+ # # Here is how to wait for a response.
1289
+ # result.wait_until_done! timeout: 60
1290
+ # if result.response?
1291
+ # p result.response
1292
+ # else
1293
+ # puts "No response received."
1294
+ # end
1295
+ #
1032
1296
  def export_registration request, options = nil
1033
1297
  raise ::ArgumentError, "request must be provided" if request.nil?
1034
1298
 
@@ -1111,6 +1375,29 @@ module Google
1111
1375
  # @return [::Gapic::Operation]
1112
1376
  #
1113
1377
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1378
+ #
1379
+ # @example Basic example
1380
+ # require "google/cloud/domains/v1"
1381
+ #
1382
+ # # Create a client object. The client can be reused for multiple calls.
1383
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
1384
+ #
1385
+ # # Create a request. To set request fields, pass in keyword arguments.
1386
+ # request = Google::Cloud::Domains::V1::DeleteRegistrationRequest.new
1387
+ #
1388
+ # # Call the delete_registration method.
1389
+ # result = client.delete_registration request
1390
+ #
1391
+ # # The returned object is of type Gapic::Operation. You can use it to
1392
+ # # check the status of an operation, cancel it, or wait for results.
1393
+ # # Here is how to wait for a response.
1394
+ # result.wait_until_done! timeout: 60
1395
+ # if result.response?
1396
+ # p result.response
1397
+ # else
1398
+ # puts "No response received."
1399
+ # end
1400
+ #
1114
1401
  def delete_registration request, options = nil
1115
1402
  raise ::ArgumentError, "request must be provided" if request.nil?
1116
1403
 
@@ -1179,6 +1466,22 @@ module Google
1179
1466
  # @return [::Google::Cloud::Domains::V1::AuthorizationCode]
1180
1467
  #
1181
1468
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1469
+ #
1470
+ # @example Basic example
1471
+ # require "google/cloud/domains/v1"
1472
+ #
1473
+ # # Create a client object. The client can be reused for multiple calls.
1474
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
1475
+ #
1476
+ # # Create a request. To set request fields, pass in keyword arguments.
1477
+ # request = Google::Cloud::Domains::V1::RetrieveAuthorizationCodeRequest.new
1478
+ #
1479
+ # # Call the retrieve_authorization_code method.
1480
+ # result = client.retrieve_authorization_code request
1481
+ #
1482
+ # # The returned object is of type Google::Cloud::Domains::V1::AuthorizationCode.
1483
+ # p result
1484
+ #
1182
1485
  def retrieve_authorization_code request, options = nil
1183
1486
  raise ::ArgumentError, "request must be provided" if request.nil?
1184
1487
 
@@ -1245,6 +1548,22 @@ module Google
1245
1548
  # @return [::Google::Cloud::Domains::V1::AuthorizationCode]
1246
1549
  #
1247
1550
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
1551
+ #
1552
+ # @example Basic example
1553
+ # require "google/cloud/domains/v1"
1554
+ #
1555
+ # # Create a client object. The client can be reused for multiple calls.
1556
+ # client = Google::Cloud::Domains::V1::Domains::Rest::Client.new
1557
+ #
1558
+ # # Create a request. To set request fields, pass in keyword arguments.
1559
+ # request = Google::Cloud::Domains::V1::ResetAuthorizationCodeRequest.new
1560
+ #
1561
+ # # Call the reset_authorization_code method.
1562
+ # result = client.reset_authorization_code request
1563
+ #
1564
+ # # The returned object is of type Google::Cloud::Domains::V1::AuthorizationCode.
1565
+ # p result
1566
+ #
1248
1567
  def reset_authorization_code request, options = nil
1249
1568
  raise ::ArgumentError, "request must be provided" if request.nil?
1250
1569
 
@@ -1310,9 +1629,9 @@ module Google
1310
1629
  # end
1311
1630
  #
1312
1631
  # @!attribute [rw] endpoint
1313
- # The hostname or hostname:port of the service endpoint.
1314
- # Defaults to `"domains.googleapis.com"`.
1315
- # @return [::String]
1632
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1633
+ # nil, indicating to use the default endpoint in the current universe domain.
1634
+ # @return [::String,nil]
1316
1635
  # @!attribute [rw] credentials
1317
1636
  # Credentials to send with calls. You may provide any of the following types:
1318
1637
  # * (`String`) The path to a service account key file in JSON format
@@ -1349,13 +1668,20 @@ module Google
1349
1668
  # @!attribute [rw] quota_project
1350
1669
  # A separate project against which to charge quota.
1351
1670
  # @return [::String]
1671
+ # @!attribute [rw] universe_domain
1672
+ # The universe domain within which to make requests. This determines the
1673
+ # default endpoint URL. The default value of nil uses the environment
1674
+ # universe (usually the default "googleapis.com" universe).
1675
+ # @return [::String,nil]
1352
1676
  #
1353
1677
  class Configuration
1354
1678
  extend ::Gapic::Config
1355
1679
 
1680
+ # @private
1681
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1356
1682
  DEFAULT_ENDPOINT = "domains.googleapis.com"
1357
1683
 
1358
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1684
+ config_attr :endpoint, nil, ::String, nil
1359
1685
  config_attr :credentials, nil do |value|
1360
1686
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1361
1687
  allowed.any? { |klass| klass === value }
@@ -1367,6 +1693,7 @@ module Google
1367
1693
  config_attr :metadata, nil, ::Hash, nil
1368
1694
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1369
1695
  config_attr :quota_project, nil, ::String, nil
1696
+ config_attr :universe_domain, nil, ::String, nil
1370
1697
 
1371
1698
  # @private
1372
1699
  def initialize parent_config = nil
data/lib/google/cloud/domains/v1/domains/rest/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module Rest
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "domains.$UNIVERSE_DOMAIN$"
31
+
29
32
  # @private
30
33
  attr_reader :operations_stub
31
34
 
@@ -60,6 +63,15 @@ module Google
60
63
  @config
61
64
  end
62
65
 
66
+ ##
67
+ # The effective universe domain
68
+ #
69
+ # @return [String]
70
+ #
71
+ def universe_domain
72
+ @operations_stub.universe_domain
73
+ end
74
+
63
75
  ##
64
76
  # Create a new Operations client object.
65
77
  #
@@ -84,8 +96,10 @@ module Google
84
96
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
85
97
 
86
98
  @operations_stub = OperationsServiceStub.new(
87
- endpoint: @config.endpoint,
88
- credentials: credentials
99
+ endpoint: @config.endpoint,
100
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
101
+ universe_domain: @config.universe_domain,
102
+ credentials: credentials
89
103
  )
90
104
 
91
105
  # Used by an LRO wrapper for some methods of this service
@@ -136,6 +150,26 @@ module Google
136
150
  # @return [::Gapic::Operation]
137
151
  #
138
152
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
153
+ #
154
+ # @example Basic example
155
+ # require "google/longrunning"
156
+ #
157
+ # # Create a client object. The client can be reused for multiple calls.
158
+ # client = Google::Longrunning::Operations::Rest::Client.new
159
+ #
160
+ # # Create a request. To set request fields, pass in keyword arguments.
161
+ # request = Google::Longrunning::ListOperationsRequest.new
162
+ #
163
+ # # Call the list_operations method.
164
+ # result = client.list_operations request
165
+ #
166
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
167
+ # # over elements, and API calls will be issued to fetch pages as needed.
168
+ # result.each do |item|
169
+ # # Each element is of type ::Google::Longrunning::Operation.
170
+ # p item
171
+ # end
172
+ #
139
173
  def list_operations request, options = nil
140
174
  raise ::ArgumentError, "request must be provided" if request.nil?
141
175
 
@@ -201,6 +235,29 @@ module Google
201
235
  # @return [::Gapic::Operation]
202
236
  #
203
237
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
238
+ #
239
+ # @example Basic example
240
+ # require "google/longrunning"
241
+ #
242
+ # # Create a client object. The client can be reused for multiple calls.
243
+ # client = Google::Longrunning::Operations::Rest::Client.new
244
+ #
245
+ # # Create a request. To set request fields, pass in keyword arguments.
246
+ # request = Google::Longrunning::GetOperationRequest.new
247
+ #
248
+ # # Call the get_operation method.
249
+ # result = client.get_operation request
250
+ #
251
+ # # The returned object is of type Gapic::Operation. You can use it to
252
+ # # check the status of an operation, cancel it, or wait for results.
253
+ # # Here is how to wait for a response.
254
+ # result.wait_until_done! timeout: 60
255
+ # if result.response?
256
+ # p result.response
257
+ # else
258
+ # puts "No response received."
259
+ # end
260
+ #
204
261
  def get_operation request, options = nil
205
262
  raise ::ArgumentError, "request must be provided" if request.nil?
206
263
 
@@ -267,6 +324,22 @@ module Google
267
324
  # @return [::Google::Protobuf::Empty]
268
325
  #
269
326
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
327
+ #
328
+ # @example Basic example
329
+ # require "google/longrunning"
330
+ #
331
+ # # Create a client object. The client can be reused for multiple calls.
332
+ # client = Google::Longrunning::Operations::Rest::Client.new
333
+ #
334
+ # # Create a request. To set request fields, pass in keyword arguments.
335
+ # request = Google::Longrunning::DeleteOperationRequest.new
336
+ #
337
+ # # Call the delete_operation method.
338
+ # result = client.delete_operation request
339
+ #
340
+ # # The returned object is of type Google::Protobuf::Empty.
341
+ # p result
342
+ #
270
343
  def delete_operation request, options = nil
271
344
  raise ::ArgumentError, "request must be provided" if request.nil?
272
345
 
@@ -338,6 +411,22 @@ module Google
338
411
  # @return [::Google::Protobuf::Empty]
339
412
  #
340
413
  # @raise [::Google::Cloud::Error] if the REST call is aborted.
414
+ #
415
+ # @example Basic example
416
+ # require "google/longrunning"
417
+ #
418
+ # # Create a client object. The client can be reused for multiple calls.
419
+ # client = Google::Longrunning::Operations::Rest::Client.new
420
+ #
421
+ # # Create a request. To set request fields, pass in keyword arguments.
422
+ # request = Google::Longrunning::CancelOperationRequest.new
423
+ #
424
+ # # Call the cancel_operation method.
425
+ # result = client.cancel_operation request
426
+ #
427
+ # # The returned object is of type Google::Protobuf::Empty.
428
+ # p result
429
+ #
341
430
  def cancel_operation request, options = nil
342
431
  raise ::ArgumentError, "request must be provided" if request.nil?
343
432
 
@@ -403,9 +492,9 @@ module Google
403
492
  # end
404
493
  #
405
494
  # @!attribute [rw] endpoint
406
- # The hostname or hostname:port of the service endpoint.
407
- # Defaults to `"domains.googleapis.com"`.
408
- # @return [::String]
495
+ # A custom service endpoint, as a hostname or hostname:port. The default is
496
+ # nil, indicating to use the default endpoint in the current universe domain.
497
+ # @return [::String,nil]
409
498
  # @!attribute [rw] credentials
410
499
  # Credentials to send with calls. You may provide any of the following types:
411
500
  # * (`String`) The path to a service account key file in JSON format
@@ -442,13 +531,20 @@ module Google
442
531
  # @!attribute [rw] quota_project
443
532
  # A separate project against which to charge quota.
444
533
  # @return [::String]
534
+ # @!attribute [rw] universe_domain
535
+ # The universe domain within which to make requests. This determines the
536
+ # default endpoint URL. The default value of nil uses the environment
537
+ # universe (usually the default "googleapis.com" universe).
538
+ # @return [::String,nil]
445
539
  #
446
540
  class Configuration
447
541
  extend ::Gapic::Config
448
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
449
545
  DEFAULT_ENDPOINT = "domains.googleapis.com"
450
546
 
451
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
452
548
  config_attr :credentials, nil do |value|
453
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
454
550
  allowed.any? { |klass| klass === value }
@@ -460,6 +556,7 @@ module Google
460
556
  config_attr :metadata, nil, ::Hash, nil
461
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
462
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
463
560
 
464
561
  # @private
465
562
  def initialize parent_config = nil
@@ -542,12 +639,15 @@ module Google
542
639
  # Service stub contains baseline method implementations
543
640
  # including transcoding, making the REST call, and deserialing the response.
544
641
  class OperationsServiceStub
545
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
546
643
  # These require statements are intentionally placed here to initialize
547
644
  # the REST modules only when it's required.
548
645
  require "gapic/rest"
549
646
 
550
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
647
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
648
+ endpoint_template: endpoint_template,
649
+ universe_domain: universe_domain,
650
+ credentials: credentials
551
651
  end
552
652
 
553
653
  ##
data/lib/google/cloud/domains/v1/domains/rest/service_stub.rb CHANGED
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the search_domains REST call
45
57
  #
data/lib/google/cloud/domains/v1/version.rb CHANGED
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Domains
23
23
  module V1
24
- VERSION = "0.4.0"
24
+ VERSION = "0.6.0"
25
25
  end
26
26
  end
27
27
  end
data/proto_docs/google/api/client.rb CHANGED
@@ -21,6 +21,7 @@ module Google
21
21
  module Api
22
22
  # Required information for every language.
23
23
  # @!attribute [rw] reference_docs_uri
24
+ # @deprecated This field is deprecated and may be removed in the next major version update.
24
25
  # @return [::String]
25
26
  # Link to automatically generated reference documentation. Example:
26
27
  # https://cloud.google.com/nodejs/docs/reference/asset/latest
@@ -304,6 +305,19 @@ module Google
304
305
  # seconds: 360 # 6 minutes
305
306
  # total_poll_timeout:
306
307
  # seconds: 54000 # 90 minutes
308
+ # @!attribute [rw] auto_populated_fields
309
+ # @return [::Array<::String>]
310
+ # List of top-level fields of the request message, that should be
311
+ # automatically populated by the client libraries based on their
312
+ # (google.api.field_info).format. Currently supported format: UUID4.
313
+ #
314
+ # Example of a YAML configuration:
315
+ #
316
+ # publishing:
317
+ # method_settings:
318
+ # - selector: google.example.v1.ExampleService.CreateExample
319
+ # auto_populated_fields:
320
+ # - request_id
307
321
  class MethodSettings
308
322
  include ::Google::Protobuf::MessageExts
309
323
  extend ::Google::Protobuf::MessageExts::ClassMethods
data/proto_docs/google/api/field_behavior.rb CHANGED
@@ -66,6 +66,20 @@ module Google
66
66
  # a non-empty value will be returned. The user will not be aware of what
67
67
  # non-empty value to expect.
68
68
  NON_EMPTY_DEFAULT = 7
69
+
70
+ # Denotes that the field in a resource (a message annotated with
71
+ # google.api.resource) is used in the resource name to uniquely identify the
72
+ # resource. For AIP-compliant APIs, this should only be applied to the
73
+ # `name` field on the resource.
74
+ #
75
+ # This behavior should not be applied to references to other resources within
76
+ # the message.
77
+ #
78
+ # The identifier field of resources often have different field behavior
79
+ # depending on the request it is embedded in (e.g. for Create methods name
80
+ # is optional and unused, while for Update methods it is required). Instead
81
+ # of method-specific annotations, only `IDENTIFIER` is required.
82
+ IDENTIFIER = 8
69
83
  end
70
84
  end
71
85
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-domains-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.0
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-06-06 00:00:00.000000000 Z
11
+ date: 2024-01-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.19.1
19
+ version: 0.21.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.19.1
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
218
218
  - !ruby/object:Gem::Version
219
219
  version: '0'
220
220
  requirements: []
221
- rubygems_version: 3.4.2
221
+ rubygems_version: 3.5.3
222
222
  signing_key:
223
223
  specification_version: 4
224
224
  summary: Enables management and configuration of domain names.