google-cloud-bigtable-admin-v2 0.20.0 → 0.21.1

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/bigtable/admin/v2/bigtable_instance_admin/client.rb +32 -8
  4. data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/operations.rb +28 -6
  5. data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/client.rb +32 -8
  6. data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/operations.rb +28 -6
  7. data/lib/google/cloud/bigtable/admin/v2/version.rb +1 -1
  8. data/proto_docs/google/api/client.rb +1 -0
  9. data/proto_docs/google/bigtable/admin/v2/instance.rb +1 -0
  10. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0ae0db67df60acd9e4d98dba37f5e0e826a5c935f8364069be6a2195b751b580
4
- data.tar.gz: b3535f196d28195a96bfa0d183d68d1d19d9f38152658b07f9de35f2350eeb37
3
+ metadata.gz: 8417173eccb8b6de4362200145c5998727a4439afc51a229eea4e7d04b1a8598
4
+ data.tar.gz: 79dd9b250003693b05885e723cb3fb3e176fa1a360ca7d38003fce9dd85ba4a5
5
5
  SHA512:
6
- metadata.gz: e827cb7bef65775275f8b983c23269e447e2bfe023b862207be12bb2836a3493bea37ae579a35778d5d3cc930d74d7a0c62ed52a241c72f7d5998f12a2b667d3
7
- data.tar.gz: 650ccf0db2b9485b742576944f3519283d02f4a887375928f07ecae70738cc5cbde69b28beebded5fddb6f9376c0d4a3dca489ab1b56a15af42299def4dd170c
6
+ metadata.gz: 30ca8681b77549b341c3f78dd62ee28c58f4996f50cb0954fcb90a4772daa666c7d2b63dcc0e3f4ee38612577a61f4d95237f5af65092fcb829b632d8723db56
7
+ data.tar.gz: 618c2b2ef1aafcb322779a384ca7bb6146d74179a9f225a43960b8a4c1e6c723b081cc0bccc01f6415ba4abe9a58d55e98cd81132e0b21339dba7e594e7eda8f
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-bigtable-admin-v2 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-bigtable-admin-v2 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 BIGTABLE_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/bigtable/admin/v2"
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::Bigtable::Admin::V2::BigtableInstanceAdmin::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-bigtable-admin-v2 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-bigtable-admin-v2 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-bigtable-admin-v2
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `BIGTABLE_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `BIGTABLE_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/bigtable/admin/v2"
77
-
78
- ENV["BIGTABLE_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::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/bigtable/admin/v2"
90
58
 
91
59
  client = ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::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/bigtable/admin/v2"
100
68
 
101
69
  ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::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::Bigtable::Admin::V2::BigtableInstanceAdmin::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-bigtable-admin-v2
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/bigtable/admin/v2"
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-bigtable-admin-v2.
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::Bigtable::Admin::V2::BigtableInstanceAdmin::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/bigtable/admin/v2/bigtable_instance_admin/client.rb CHANGED
@@ -33,6 +33,9 @@ module Google
33
33
  # tables' metadata or data stored in those tables.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ DEFAULT_ENDPOINT_TEMPLATE = "bigtableadmin.$UNIVERSE_DOMAIN$"
38
+
36
39
  include Paths
37
40
 
38
41
  # @private
@@ -172,6 +175,15 @@ module Google
172
175
  @config
173
176
  end
174
177
 
178
+ ##
179
+ # The effective universe domain
180
+ #
181
+ # @return [String]
182
+ #
183
+ def universe_domain
184
+ @bigtable_instance_admin_stub.universe_domain
185
+ end
186
+
175
187
  ##
176
188
  # Create a new BigtableInstanceAdmin client object.
177
189
  #
@@ -205,8 +217,9 @@ module Google
205
217
  credentials = @config.credentials
206
218
  # Use self-signed JWT if the endpoint is unchanged from default,
207
219
  # but only if the default endpoint does not have a region prefix.
208
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
209
- !@config.endpoint.split(".").first.include?("-")
220
+ enable_self_signed_jwt = @config.endpoint.nil? ||
221
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
222
+ !@config.endpoint.split(".").first.include?("-"))
210
223
  credentials ||= Credentials.default scope: @config.scope,
211
224
  enable_self_signed_jwt: enable_self_signed_jwt
212
225
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -219,12 +232,15 @@ module Google
219
232
  config.credentials = credentials
220
233
  config.quota_project = @quota_project_id
221
234
  config.endpoint = @config.endpoint
235
+ config.universe_domain = @config.universe_domain
222
236
  end
223
237
 
224
238
  @bigtable_instance_admin_stub = ::Gapic::ServiceStub.new(
225
239
  ::Google::Cloud::Bigtable::Admin::V2::BigtableInstanceAdmin::Stub,
226
- credentials: credentials,
227
- endpoint: @config.endpoint,
240
+ credentials: credentials,
241
+ endpoint: @config.endpoint,
242
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
243
+ universe_domain: @config.universe_domain,
228
244
  channel_args: @config.channel_args,
229
245
  interceptors: @config.interceptors,
230
246
  channel_pool_config: @config.channel_pool
@@ -2306,9 +2322,9 @@ module Google
2306
2322
  # end
2307
2323
  #
2308
2324
  # @!attribute [rw] endpoint
2309
- # The hostname or hostname:port of the service endpoint.
2310
- # Defaults to `"bigtableadmin.googleapis.com"`.
2311
- # @return [::String]
2325
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2326
+ # nil, indicating to use the default endpoint in the current universe domain.
2327
+ # @return [::String,nil]
2312
2328
  # @!attribute [rw] credentials
2313
2329
  # Credentials to send with calls. You may provide any of the following types:
2314
2330
  # * (`String`) The path to a service account key file in JSON format
@@ -2354,13 +2370,20 @@ module Google
2354
2370
  # @!attribute [rw] quota_project
2355
2371
  # A separate project against which to charge quota.
2356
2372
  # @return [::String]
2373
+ # @!attribute [rw] universe_domain
2374
+ # The universe domain within which to make requests. This determines the
2375
+ # default endpoint URL. The default value of nil uses the environment
2376
+ # universe (usually the default "googleapis.com" universe).
2377
+ # @return [::String,nil]
2357
2378
  #
2358
2379
  class Configuration
2359
2380
  extend ::Gapic::Config
2360
2381
 
2382
+ # @private
2383
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2361
2384
  DEFAULT_ENDPOINT = "bigtableadmin.googleapis.com"
2362
2385
 
2363
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2386
+ config_attr :endpoint, nil, ::String, nil
2364
2387
  config_attr :credentials, nil do |value|
2365
2388
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2366
2389
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2375,6 +2398,7 @@ module Google
2375
2398
  config_attr :metadata, nil, ::Hash, nil
2376
2399
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2377
2400
  config_attr :quota_project, nil, ::String, nil
2401
+ config_attr :universe_domain, nil, ::String, nil
2378
2402
 
2379
2403
  # @private
2380
2404
  def initialize parent_config = nil
data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/operations.rb CHANGED
@@ -27,6 +27,9 @@ module Google
27
27
  module BigtableInstanceAdmin
28
28
  # Service that implements Longrunning Operations API.
29
29
  class Operations
30
+ # @private
31
+ DEFAULT_ENDPOINT_TEMPLATE = "bigtableadmin.$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 `"bigtableadmin.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 = "bigtableadmin.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/bigtable/admin/v2/bigtable_table_admin/client.rb CHANGED
@@ -35,6 +35,9 @@ module Google
35
35
  # the tables.
36
36
  #
37
37
  class Client
38
+ # @private
39
+ DEFAULT_ENDPOINT_TEMPLATE = "bigtableadmin.$UNIVERSE_DOMAIN$"
40
+
38
41
  include Paths
39
42
 
40
43
  # @private
@@ -165,6 +168,15 @@ module Google
165
168
  @config
166
169
  end
167
170
 
171
+ ##
172
+ # The effective universe domain
173
+ #
174
+ # @return [String]
175
+ #
176
+ def universe_domain
177
+ @bigtable_table_admin_stub.universe_domain
178
+ end
179
+
168
180
  ##
169
181
  # Create a new BigtableTableAdmin client object.
170
182
  #
@@ -198,8 +210,9 @@ module Google
198
210
  credentials = @config.credentials
199
211
  # Use self-signed JWT if the endpoint is unchanged from default,
200
212
  # but only if the default endpoint does not have a region prefix.
201
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
202
- !@config.endpoint.split(".").first.include?("-")
213
+ enable_self_signed_jwt = @config.endpoint.nil? ||
214
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
215
+ !@config.endpoint.split(".").first.include?("-"))
203
216
  credentials ||= Credentials.default scope: @config.scope,
204
217
  enable_self_signed_jwt: enable_self_signed_jwt
205
218
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -212,12 +225,15 @@ module Google
212
225
  config.credentials = credentials
213
226
  config.quota_project = @quota_project_id
214
227
  config.endpoint = @config.endpoint
228
+ config.universe_domain = @config.universe_domain
215
229
  end
216
230
 
217
231
  @bigtable_table_admin_stub = ::Gapic::ServiceStub.new(
218
232
  ::Google::Cloud::Bigtable::Admin::V2::BigtableTableAdmin::Stub,
219
- credentials: credentials,
220
- endpoint: @config.endpoint,
233
+ credentials: credentials,
234
+ endpoint: @config.endpoint,
235
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
236
+ universe_domain: @config.universe_domain,
221
237
  channel_args: @config.channel_args,
222
238
  interceptors: @config.interceptors,
223
239
  channel_pool_config: @config.channel_pool
@@ -2795,9 +2811,9 @@ module Google
2795
2811
  # end
2796
2812
  #
2797
2813
  # @!attribute [rw] endpoint
2798
- # The hostname or hostname:port of the service endpoint.
2799
- # Defaults to `"bigtableadmin.googleapis.com"`.
2800
- # @return [::String]
2814
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2815
+ # nil, indicating to use the default endpoint in the current universe domain.
2816
+ # @return [::String,nil]
2801
2817
  # @!attribute [rw] credentials
2802
2818
  # Credentials to send with calls. You may provide any of the following types:
2803
2819
  # * (`String`) The path to a service account key file in JSON format
@@ -2843,13 +2859,20 @@ module Google
2843
2859
  # @!attribute [rw] quota_project
2844
2860
  # A separate project against which to charge quota.
2845
2861
  # @return [::String]
2862
+ # @!attribute [rw] universe_domain
2863
+ # The universe domain within which to make requests. This determines the
2864
+ # default endpoint URL. The default value of nil uses the environment
2865
+ # universe (usually the default "googleapis.com" universe).
2866
+ # @return [::String,nil]
2846
2867
  #
2847
2868
  class Configuration
2848
2869
  extend ::Gapic::Config
2849
2870
 
2871
+ # @private
2872
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2850
2873
  DEFAULT_ENDPOINT = "bigtableadmin.googleapis.com"
2851
2874
 
2852
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2875
+ config_attr :endpoint, nil, ::String, nil
2853
2876
  config_attr :credentials, nil do |value|
2854
2877
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2855
2878
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -2864,6 +2887,7 @@ module Google
2864
2887
  config_attr :metadata, nil, ::Hash, nil
2865
2888
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2866
2889
  config_attr :quota_project, nil, ::String, nil
2890
+ config_attr :universe_domain, nil, ::String, nil
2867
2891
 
2868
2892
  # @private
2869
2893
  def initialize parent_config = nil
data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/operations.rb CHANGED
@@ -27,6 +27,9 @@ module Google
27
27
  module BigtableTableAdmin
28
28
  # Service that implements Longrunning Operations API.
29
29
  class Operations
30
+ # @private
31
+ DEFAULT_ENDPOINT_TEMPLATE = "bigtableadmin.$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 `"bigtableadmin.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 = "bigtableadmin.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/bigtable/admin/v2/version.rb CHANGED
@@ -22,7 +22,7 @@ module Google
22
22
  module Bigtable
23
23
  module Admin
24
24
  module V2
25
- VERSION = "0.20.0"
25
+ VERSION = "0.21.1"
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
data/proto_docs/google/bigtable/admin/v2/instance.rb CHANGED
@@ -265,6 +265,7 @@ module Google
265
265
  # @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::SingleClusterRouting]
266
266
  # Use a single-cluster routing policy.
267
267
  # @!attribute [rw] priority
268
+ # @deprecated This field is deprecated and may be removed in the next major version update.
268
269
  # @return [::Google::Cloud::Bigtable::Admin::V2::AppProfile::Priority]
269
270
  # This field has been deprecated in favor of `standard_isolation.priority`.
270
271
  # If you set this field, `standard_isolation.priority` will be set instead.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-bigtable-admin-v2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.20.0
4
+ version: 0.21.1
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-12 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