google-cloud-firestore-admin-v1 0.13.0 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb +33 -8
  4. data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb +28 -6
  5. data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/client.rb +35 -7
  6. data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/operations.rb +33 -8
  7. data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/firestore/admin/v1/version.rb +1 -1
  9. data/proto_docs/google/api/client.rb +1 -0
  10. metadata +6 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 603f0f1959c31b28bbf809414ada4c7ddfc014c71665e3506b9c3a9ba1497cf6
4
- data.tar.gz: 02b181132216523c8a613e558599ea34fb7e9f268d420de466993164ae2a3c64
3
+ metadata.gz: 82b9e3bc129b384d9980d9c76be20b095638908338cde74514dcbfcb45312c19
4
+ data.tar.gz: 78ebaecf5aeaee77603a3fceb78e2e69bb9cf6422b86f419a0d5e2df739b4875
5
5
  SHA512:
6
- metadata.gz: ad47026a9c92848c3be3c8f3c942e8eb2e46ff0221a00d0b3f74afb908035b67b760ef434324a0187cd9890166096f3c5b09bf51d6f4bec2fdfd816f7f94d969
7
- data.tar.gz: 46dcd11c448c72654d05b573dd85bb1d9fbfefd3bfdeae2e832d5257678a885a44a3258f4c6617e2eb32716cfd551d40d010a65deb4584740878e6ed78a4a7c4
6
+ metadata.gz: 85b53435eb6822b7d412c9ca611a97f8016a16c9b187a7b4079801be0519a5d63f8e83754b1e619e00210b27b17435aff73ce07c9145994beac048f1d1da217a
7
+ data.tar.gz: c7a839510a1d703912e6bc7243a1920ec59bddc98ff73088b5ce47650df8f1b9c4e81f2385857aeae74b3bbcb4b72b7e04760ab3f665949dcf6afa4243701c05
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-firestore-admin-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-firestore-admin-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 FIRESTORE_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/firestore/admin/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::Firestore::Admin::V1::FirestoreAdmin::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-firestore-admin-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-firestore-admin-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-firestore-admin-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `FIRESTORE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `FIRESTORE_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/firestore/admin/v1"
77
-
78
- ENV["FIRESTORE_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::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/firestore/admin/v1"
90
58
 
91
59
  client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::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/firestore/admin/v1"
100
68
 
101
69
  ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::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::Firestore::Admin::V1::FirestoreAdmin::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-firestore-admin-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/firestore/admin/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-firestore-admin-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::Firestore::Admin::V1::FirestoreAdmin::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/firestore/admin/v1/firestore_admin/client.rb CHANGED
@@ -59,6 +59,9 @@ module Google
59
59
  # service `google.longrunning.Operations`.
60
60
  #
61
61
  class Client
62
+ # @private
63
+ DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$"
64
+
62
65
  include Paths
63
66
 
64
67
  # @private
@@ -152,6 +155,15 @@ module Google
152
155
  @config
153
156
  end
154
157
 
158
+ ##
159
+ # The effective universe domain
160
+ #
161
+ # @return [String]
162
+ #
163
+ def universe_domain
164
+ @firestore_admin_stub.universe_domain
165
+ end
166
+
155
167
  ##
156
168
  # Create a new FirestoreAdmin client object.
157
169
  #
@@ -185,8 +197,9 @@ module Google
185
197
  credentials = @config.credentials
186
198
  # Use self-signed JWT if the endpoint is unchanged from default,
187
199
  # but only if the default endpoint does not have a region prefix.
188
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
189
- !@config.endpoint.split(".").first.include?("-")
200
+ enable_self_signed_jwt = @config.endpoint.nil? ||
201
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
202
+ !@config.endpoint.split(".").first.include?("-"))
190
203
  credentials ||= Credentials.default scope: @config.scope,
191
204
  enable_self_signed_jwt: enable_self_signed_jwt
192
205
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -199,18 +212,22 @@ module Google
199
212
  config.credentials = credentials
200
213
  config.quota_project = @quota_project_id
201
214
  config.endpoint = @config.endpoint
215
+ config.universe_domain = @config.universe_domain
202
216
  end
203
217
 
204
218
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
205
219
  config.credentials = credentials
206
220
  config.quota_project = @quota_project_id
207
221
  config.endpoint = @config.endpoint
222
+ config.universe_domain = @config.universe_domain
208
223
  end
209
224
 
210
225
  @firestore_admin_stub = ::Gapic::ServiceStub.new(
211
226
  ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Stub,
212
- credentials: credentials,
213
- endpoint: @config.endpoint,
227
+ credentials: credentials,
228
+ endpoint: @config.endpoint,
229
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
230
+ universe_domain: @config.universe_domain,
214
231
  channel_args: @config.channel_args,
215
232
  interceptors: @config.interceptors,
216
233
  channel_pool_config: @config.channel_pool
@@ -1657,9 +1674,9 @@ module Google
1657
1674
  # end
1658
1675
  #
1659
1676
  # @!attribute [rw] endpoint
1660
- # The hostname or hostname:port of the service endpoint.
1661
- # Defaults to `"firestore.googleapis.com"`.
1662
- # @return [::String]
1677
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1678
+ # nil, indicating to use the default endpoint in the current universe domain.
1679
+ # @return [::String,nil]
1663
1680
  # @!attribute [rw] credentials
1664
1681
  # Credentials to send with calls. You may provide any of the following types:
1665
1682
  # * (`String`) The path to a service account key file in JSON format
@@ -1705,13 +1722,20 @@ module Google
1705
1722
  # @!attribute [rw] quota_project
1706
1723
  # A separate project against which to charge quota.
1707
1724
  # @return [::String]
1725
+ # @!attribute [rw] universe_domain
1726
+ # The universe domain within which to make requests. This determines the
1727
+ # default endpoint URL. The default value of nil uses the environment
1728
+ # universe (usually the default "googleapis.com" universe).
1729
+ # @return [::String,nil]
1708
1730
  #
1709
1731
  class Configuration
1710
1732
  extend ::Gapic::Config
1711
1733
 
1734
+ # @private
1735
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1712
1736
  DEFAULT_ENDPOINT = "firestore.googleapis.com"
1713
1737
 
1714
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1738
+ config_attr :endpoint, nil, ::String, nil
1715
1739
  config_attr :credentials, nil do |value|
1716
1740
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1717
1741
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1726,6 +1750,7 @@ module Google
1726
1750
  config_attr :metadata, nil, ::Hash, nil
1727
1751
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1728
1752
  config_attr :quota_project, nil, ::String, nil
1753
+ config_attr :universe_domain, nil, ::String, nil
1729
1754
 
1730
1755
  # @private
1731
1756
  def initialize parent_config = nil
data/lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb CHANGED
@@ -27,6 +27,9 @@ module Google
27
27
  module FirestoreAdmin
28
28
  # Service that implements Longrunning Operations API.
29
29
  class Operations
30
+ # @private
31
+ DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$"
32
+
30
33
  # @private
31
34
  attr_reader :operations_stub
32
35
 
@@ -61,6 +64,15 @@ module Google
61
64
  @config
62
65
  end
63
66
 
67
+ ##
68
+ # The effective universe domain
69
+ #
70
+ # @return [String]
71
+ #
72
+ def universe_domain
73
+ @operations_stub.universe_domain
74
+ end
75
+
64
76
  ##
65
77
  # Create a new Operations client object.
66
78
  #
@@ -91,8 +103,10 @@ module Google
91
103
 
92
104
  @operations_stub = ::Gapic::ServiceStub.new(
93
105
  ::Google::Longrunning::Operations::Stub,
94
- credentials: credentials,
95
- endpoint: @config.endpoint,
106
+ credentials: credentials,
107
+ endpoint: @config.endpoint,
108
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
109
+ universe_domain: @config.universe_domain,
96
110
  channel_args: @config.channel_args,
97
111
  interceptors: @config.interceptors,
98
112
  channel_pool_config: @config.channel_pool
@@ -614,9 +628,9 @@ module Google
614
628
  # end
615
629
  #
616
630
  # @!attribute [rw] endpoint
617
- # The hostname or hostname:port of the service endpoint.
618
- # Defaults to `"firestore.googleapis.com"`.
619
- # @return [::String]
631
+ # A custom service endpoint, as a hostname or hostname:port. The default is
632
+ # nil, indicating to use the default endpoint in the current universe domain.
633
+ # @return [::String,nil]
620
634
  # @!attribute [rw] credentials
621
635
  # Credentials to send with calls. You may provide any of the following types:
622
636
  # * (`String`) The path to a service account key file in JSON format
@@ -662,13 +676,20 @@ module Google
662
676
  # @!attribute [rw] quota_project
663
677
  # A separate project against which to charge quota.
664
678
  # @return [::String]
679
+ # @!attribute [rw] universe_domain
680
+ # The universe domain within which to make requests. This determines the
681
+ # default endpoint URL. The default value of nil uses the environment
682
+ # universe (usually the default "googleapis.com" universe).
683
+ # @return [::String,nil]
665
684
  #
666
685
  class Configuration
667
686
  extend ::Gapic::Config
668
687
 
688
+ # @private
689
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
669
690
  DEFAULT_ENDPOINT = "firestore.googleapis.com"
670
691
 
671
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
692
+ config_attr :endpoint, nil, ::String, nil
672
693
  config_attr :credentials, nil do |value|
673
694
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
674
695
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -683,6 +704,7 @@ module Google
683
704
  config_attr :metadata, nil, ::Hash, nil
684
705
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
685
706
  config_attr :quota_project, nil, ::String, nil
707
+ config_attr :universe_domain, nil, ::String, nil
686
708
 
687
709
  # @private
688
710
  def initialize parent_config = nil
data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/client.rb CHANGED
@@ -61,6 +61,9 @@ module Google
61
61
  # service `google.longrunning.Operations`.
62
62
  #
63
63
  class Client
64
+ # @private
65
+ DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$"
66
+
64
67
  include Paths
65
68
 
66
69
  # @private
@@ -154,6 +157,15 @@ module Google
154
157
  @config
155
158
  end
156
159
 
160
+ ##
161
+ # The effective universe domain
162
+ #
163
+ # @return [String]
164
+ #
165
+ def universe_domain
166
+ @firestore_admin_stub.universe_domain
167
+ end
168
+
157
169
  ##
158
170
  # Create a new FirestoreAdmin REST client object.
159
171
  #
@@ -181,8 +193,9 @@ module Google
181
193
  credentials = @config.credentials
182
194
  # Use self-signed JWT if the endpoint is unchanged from default,
183
195
  # but only if the default endpoint does not have a region prefix.
184
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
185
- !@config.endpoint.split(".").first.include?("-")
196
+ enable_self_signed_jwt = @config.endpoint.nil? ||
197
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
198
+ !@config.endpoint.split(".").first.include?("-"))
186
199
  credentials ||= Credentials.default scope: @config.scope,
187
200
  enable_self_signed_jwt: enable_self_signed_jwt
188
201
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -196,15 +209,22 @@ module Google
196
209
  config.credentials = credentials
197
210
  config.quota_project = @quota_project_id
198
211
  config.endpoint = @config.endpoint
212
+ config.universe_domain = @config.universe_domain
199
213
  end
200
214
 
201
215
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
202
216
  config.credentials = credentials
203
217
  config.quota_project = @quota_project_id
204
218
  config.endpoint = @config.endpoint
219
+ config.universe_domain = @config.universe_domain
205
220
  end
206
221
 
207
- @firestore_admin_stub = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
222
+ @firestore_admin_stub = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::ServiceStub.new(
223
+ endpoint: @config.endpoint,
224
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
225
+ universe_domain: @config.universe_domain,
226
+ credentials: credentials
227
+ )
208
228
  end
209
229
 
210
230
  ##
@@ -1549,9 +1569,9 @@ module Google
1549
1569
  # end
1550
1570
  #
1551
1571
  # @!attribute [rw] endpoint
1552
- # The hostname or hostname:port of the service endpoint.
1553
- # Defaults to `"firestore.googleapis.com"`.
1554
- # @return [::String]
1572
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1573
+ # nil, indicating to use the default endpoint in the current universe domain.
1574
+ # @return [::String,nil]
1555
1575
  # @!attribute [rw] credentials
1556
1576
  # Credentials to send with calls. You may provide any of the following types:
1557
1577
  # * (`String`) The path to a service account key file in JSON format
@@ -1588,13 +1608,20 @@ module Google
1588
1608
  # @!attribute [rw] quota_project
1589
1609
  # A separate project against which to charge quota.
1590
1610
  # @return [::String]
1611
+ # @!attribute [rw] universe_domain
1612
+ # The universe domain within which to make requests. This determines the
1613
+ # default endpoint URL. The default value of nil uses the environment
1614
+ # universe (usually the default "googleapis.com" universe).
1615
+ # @return [::String,nil]
1591
1616
  #
1592
1617
  class Configuration
1593
1618
  extend ::Gapic::Config
1594
1619
 
1620
+ # @private
1621
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1595
1622
  DEFAULT_ENDPOINT = "firestore.googleapis.com"
1596
1623
 
1597
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1624
+ config_attr :endpoint, nil, ::String, nil
1598
1625
  config_attr :credentials, nil do |value|
1599
1626
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1600
1627
  allowed.any? { |klass| klass === value }
@@ -1606,6 +1633,7 @@ module Google
1606
1633
  config_attr :metadata, nil, ::Hash, nil
1607
1634
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1608
1635
  config_attr :quota_project, nil, ::String, nil
1636
+ config_attr :universe_domain, nil, ::String, nil
1609
1637
 
1610
1638
  # @private
1611
1639
  def initialize parent_config = nil
data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/operations.rb CHANGED
@@ -27,6 +27,9 @@ module Google
27
27
  module Rest
28
28
  # Service that implements Longrunning Operations API.
29
29
  class Operations
30
+ # @private
31
+ DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$"
32
+
30
33
  # @private
31
34
  attr_reader :operations_stub
32
35
 
@@ -61,6 +64,15 @@ module Google
61
64
  @config
62
65
  end
63
66
 
67
+ ##
68
+ # The effective universe domain
69
+ #
70
+ # @return [String]
71
+ #
72
+ def universe_domain
73
+ @operations_stub.universe_domain
74
+ end
75
+
64
76
  ##
65
77
  # Create a new Operations client object.
66
78
  #
@@ -85,8 +97,10 @@ module Google
85
97
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
86
98
 
87
99
  @operations_stub = OperationsServiceStub.new(
88
- endpoint: @config.endpoint,
89
- credentials: credentials
100
+ endpoint: @config.endpoint,
101
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
102
+ universe_domain: @config.universe_domain,
103
+ credentials: credentials
90
104
  )
91
105
 
92
106
  # Used by an LRO wrapper for some methods of this service
@@ -479,9 +493,9 @@ module Google
479
493
  # end
480
494
  #
481
495
  # @!attribute [rw] endpoint
482
- # The hostname or hostname:port of the service endpoint.
483
- # Defaults to `"firestore.googleapis.com"`.
484
- # @return [::String]
496
+ # A custom service endpoint, as a hostname or hostname:port. The default is
497
+ # nil, indicating to use the default endpoint in the current universe domain.
498
+ # @return [::String,nil]
485
499
  # @!attribute [rw] credentials
486
500
  # Credentials to send with calls. You may provide any of the following types:
487
501
  # * (`String`) The path to a service account key file in JSON format
@@ -518,13 +532,20 @@ module Google
518
532
  # @!attribute [rw] quota_project
519
533
  # A separate project against which to charge quota.
520
534
  # @return [::String]
535
+ # @!attribute [rw] universe_domain
536
+ # The universe domain within which to make requests. This determines the
537
+ # default endpoint URL. The default value of nil uses the environment
538
+ # universe (usually the default "googleapis.com" universe).
539
+ # @return [::String,nil]
521
540
  #
522
541
  class Configuration
523
542
  extend ::Gapic::Config
524
543
 
544
+ # @private
545
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
525
546
  DEFAULT_ENDPOINT = "firestore.googleapis.com"
526
547
 
527
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
548
+ config_attr :endpoint, nil, ::String, nil
528
549
  config_attr :credentials, nil do |value|
529
550
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
530
551
  allowed.any? { |klass| klass === value }
@@ -536,6 +557,7 @@ module Google
536
557
  config_attr :metadata, nil, ::Hash, nil
537
558
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
538
559
  config_attr :quota_project, nil, ::String, nil
560
+ config_attr :universe_domain, nil, ::String, nil
539
561
 
540
562
  # @private
541
563
  def initialize parent_config = nil
@@ -618,12 +640,15 @@ module Google
618
640
  # Service stub contains baseline method implementations
619
641
  # including transcoding, making the REST call, and deserialing the response.
620
642
  class OperationsServiceStub
621
- def initialize endpoint:, credentials:
643
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
622
644
  # These require statements are intentionally placed here to initialize
623
645
  # the REST modules only when it's required.
624
646
  require "gapic/rest"
625
647
 
626
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
648
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
649
+ endpoint_template: endpoint_template,
650
+ universe_domain: universe_domain,
651
+ credentials: credentials
627
652
  end
628
653
 
629
654
  ##
data/lib/google/cloud/firestore/admin/v1/firestore_admin/rest/service_stub.rb CHANGED
@@ -31,16 +31,28 @@ module Google
31
31
  # including transcoding, making the REST call, and deserialing the response.
32
32
  #
33
33
  class ServiceStub
34
- def initialize endpoint:, credentials:
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
35
35
  # These require statements are intentionally placed here to initialize
36
36
  # the REST modules only when it's required.
37
37
  require "gapic/rest"
38
38
 
39
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
39
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
40
+ endpoint_template: endpoint_template,
41
+ universe_domain: universe_domain,
42
+ credentials: credentials,
40
43
  numeric_enums: true,
41
44
  raise_faraday_errors: false
42
45
  end
43
46
 
47
+ ##
48
+ # The effective universe domain
49
+ #
50
+ # @return [String]
51
+ #
52
+ def universe_domain
53
+ @client_stub.universe_domain
54
+ end
55
+
44
56
  ##
45
57
  # Baseline implementation for the create_index REST call
46
58
  #
data/lib/google/cloud/firestore/admin/v1/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Firestore
23
23
  module Admin
24
24
  module V1
25
- VERSION = "0.13.0"
25
+ VERSION = "0.14.0"
26
26
  end
27
27
  end
28
28
  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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-admin-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.13.0
4
+ version: 0.14.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: 2024-01-03 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.20.0
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.20.0
29
+ version: 0.21.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,7 +50,7 @@ dependencies:
50
50
  requirements:
51
51
  - - ">="
52
52
  - !ruby/object:Gem::Version
53
- version: '0.4'
53
+ version: '0.7'
54
54
  - - "<"
55
55
  - !ruby/object:Gem::Version
56
56
  version: 2.a
@@ -60,7 +60,7 @@ dependencies:
60
60
  requirements:
61
61
  - - ">="
62
62
  - !ruby/object:Gem::Version
63
- version: '0.4'
63
+ version: '0.7'
64
64
  - - "<"
65
65
  - !ruby/object:Gem::Version
66
66
  version: 2.a