google-cloud-data_catalog-v1 0.20.0 → 0.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (19) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -101
  3. data/lib/google/cloud/data_catalog/v1/data_catalog/client.rb +33 -8
  4. data/lib/google/cloud/data_catalog/v1/data_catalog/operations.rb +28 -6
  5. data/lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb +35 -7
  6. data/lib/google/cloud/data_catalog/v1/data_catalog/rest/operations.rb +33 -8
  7. data/lib/google/cloud/data_catalog/v1/data_catalog/rest/service_stub.rb +14 -2
  8. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/client.rb +32 -8
  9. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/rest/client.rb +34 -7
  10. data/lib/google/cloud/data_catalog/v1/policy_tag_manager/rest/service_stub.rb +14 -2
  11. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/client.rb +32 -8
  12. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/client.rb +34 -7
  13. data/lib/google/cloud/data_catalog/v1/policy_tag_manager_serialization/rest/service_stub.rb +14 -2
  14. data/lib/google/cloud/data_catalog/v1/version.rb +1 -1
  15. data/lib/google/cloud/datacatalog/v1/policytagmanager_pb.rb +1 -1
  16. data/proto_docs/google/api/client.rb +14 -0
  17. data/proto_docs/google/cloud/datacatalog/v1/datacatalog.rb +1 -0
  18. data/proto_docs/google/cloud/datacatalog/v1/policytagmanager.rb +4 -4
  19. metadata +7 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a9844e04c2f02e462715c91596f72ba489f7c88046bbd4659e4e184d380fc0ff
4
- data.tar.gz: b8042ea78342866bf72e82c1ced62f5c08f38392da9b4f93df774997037b47c3
3
+ metadata.gz: 7ed6e86c73a297f916731890d1ad2d7fddd8c69d25efc2d356869cc2ceb06853
4
+ data.tar.gz: a61dc1fb593ccc921f92444fbe1797dd36076c4a21dcb0211a25f5cdfeb36666
5
5
  SHA512:
6
- metadata.gz: cc72a01ff5862313f9a66b89c0d8cee91b62eafd608ed0030a5e2ef44be151959a65c4eede6cad8933767e9dba3b6083bf8e5b61c35b681540e6acb6da54d2b6
7
- data.tar.gz: c658d1361e712cbe66ee34f68f0bb64d67c54c182580e82818416eb76a8ef90290447fca9f45d52e00cf5920f4de2677ad8fa0ff05f04c98938956867af25dce
6
+ metadata.gz: ab2564cfd3920599e193caa314594b714452a9cd17db1c24be3db3eed2292e4011ef64d509c0e37d732f6baf1c4ea41314453bab448c135256a86e1630ed73cc
7
+ data.tar.gz: 0b5230b42ba2ee51a76077a51cf5fd04c71a0b02f7a429a2dd0c43673d2ee9afb0526ad60e185cf4b0207a14224c8776dd5f0be3640a4f7e4a0e600659474eb6
data/AUTHENTICATION.md CHANGED
@@ -1,151 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-data_catalog-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-data_catalog-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 DATA_CATALOG_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/data_catalog/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::DataCatalog::V1::DataCatalog::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-data_catalog-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-data_catalog-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-data_catalog-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::DataCatalog::V1::DataCatalog::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `DATA_CATALOG_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `DATA_CATALOG_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/data_catalog/v1"
77
-
78
- ENV["DATA_CATALOG_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
79
43
 
80
- client = ::Google::Cloud::DataCatalog::V1::DataCatalog::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/data_catalog/v1"
90
58
 
91
59
  client = ::Google::Cloud::DataCatalog::V1::DataCatalog::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/data_catalog/v1"
100
68
 
101
69
  ::Google::Cloud::DataCatalog::V1::DataCatalog::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::DataCatalog::V1::DataCatalog::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-data_catalog-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/data_catalog/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-data_catalog-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::DataCatalog::V1::DataCatalog::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/data_catalog/v1/data_catalog/client.rb CHANGED
@@ -32,6 +32,9 @@ module Google
32
32
  # your data.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "datacatalog.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -97,6 +100,15 @@ module Google
97
100
  @config
98
101
  end
99
102
 
103
+ ##
104
+ # The effective universe domain
105
+ #
106
+ # @return [String]
107
+ #
108
+ def universe_domain
109
+ @data_catalog_stub.universe_domain
110
+ end
111
+
100
112
  ##
101
113
  # Create a new DataCatalog client object.
102
114
  #
@@ -130,8 +142,9 @@ module Google
130
142
  credentials = @config.credentials
131
143
  # Use self-signed JWT if the endpoint is unchanged from default,
132
144
  # but only if the default endpoint does not have a region prefix.
133
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
134
- !@config.endpoint.split(".").first.include?("-")
145
+ enable_self_signed_jwt = @config.endpoint.nil? ||
146
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
147
+ !@config.endpoint.split(".").first.include?("-"))
135
148
  credentials ||= Credentials.default scope: @config.scope,
136
149
  enable_self_signed_jwt: enable_self_signed_jwt
137
150
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -144,18 +157,22 @@ module Google
144
157
  config.credentials = credentials
145
158
  config.quota_project = @quota_project_id
146
159
  config.endpoint = @config.endpoint
160
+ config.universe_domain = @config.universe_domain
147
161
  end
148
162
 
149
163
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
150
164
  config.credentials = credentials
151
165
  config.quota_project = @quota_project_id
152
166
  config.endpoint = @config.endpoint
167
+ config.universe_domain = @config.universe_domain
153
168
  end
154
169
 
155
170
  @data_catalog_stub = ::Gapic::ServiceStub.new(
156
171
  ::Google::Cloud::DataCatalog::V1::DataCatalog::Stub,
157
- credentials: credentials,
158
- endpoint: @config.endpoint,
172
+ credentials: credentials,
173
+ endpoint: @config.endpoint,
174
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
175
+ universe_domain: @config.universe_domain,
159
176
  channel_args: @config.channel_args,
160
177
  interceptors: @config.interceptors,
161
178
  channel_pool_config: @config.channel_pool
@@ -3657,9 +3674,9 @@ module Google
3657
3674
  # end
3658
3675
  #
3659
3676
  # @!attribute [rw] endpoint
3660
- # The hostname or hostname:port of the service endpoint.
3661
- # Defaults to `"datacatalog.googleapis.com"`.
3662
- # @return [::String]
3677
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3678
+ # nil, indicating to use the default endpoint in the current universe domain.
3679
+ # @return [::String,nil]
3663
3680
  # @!attribute [rw] credentials
3664
3681
  # Credentials to send with calls. You may provide any of the following types:
3665
3682
  # * (`String`) The path to a service account key file in JSON format
@@ -3705,13 +3722,20 @@ module Google
3705
3722
  # @!attribute [rw] quota_project
3706
3723
  # A separate project against which to charge quota.
3707
3724
  # @return [::String]
3725
+ # @!attribute [rw] universe_domain
3726
+ # The universe domain within which to make requests. This determines the
3727
+ # default endpoint URL. The default value of nil uses the environment
3728
+ # universe (usually the default "googleapis.com" universe).
3729
+ # @return [::String,nil]
3708
3730
  #
3709
3731
  class Configuration
3710
3732
  extend ::Gapic::Config
3711
3733
 
3734
+ # @private
3735
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3712
3736
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
3713
3737
 
3714
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3738
+ config_attr :endpoint, nil, ::String, nil
3715
3739
  config_attr :credentials, nil do |value|
3716
3740
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3717
3741
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -3726,6 +3750,7 @@ module Google
3726
3750
  config_attr :metadata, nil, ::Hash, nil
3727
3751
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3728
3752
  config_attr :quota_project, nil, ::String, nil
3753
+ config_attr :universe_domain, nil, ::String, nil
3729
3754
 
3730
3755
  # @private
3731
3756
  def initialize parent_config = nil
data/lib/google/cloud/data_catalog/v1/data_catalog/operations.rb CHANGED
@@ -26,6 +26,9 @@ module Google
26
26
  module DataCatalog
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "datacatalog.$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,8 +102,10 @@ 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
110
  interceptors: @config.interceptors,
97
111
  channel_pool_config: @config.channel_pool
@@ -613,9 +627,9 @@ module Google
613
627
  # end
614
628
  #
615
629
  # @!attribute [rw] endpoint
616
- # The hostname or hostname:port of the service endpoint.
617
- # Defaults to `"datacatalog.googleapis.com"`.
618
- # @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]
619
633
  # @!attribute [rw] credentials
620
634
  # Credentials to send with calls. You may provide any of the following types:
621
635
  # * (`String`) The path to a service account key file in JSON format
@@ -661,13 +675,20 @@ module Google
661
675
  # @!attribute [rw] quota_project
662
676
  # A separate project against which to charge quota.
663
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]
664
683
  #
665
684
  class Configuration
666
685
  extend ::Gapic::Config
667
686
 
687
+ # @private
688
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
668
689
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
669
690
 
670
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
691
+ config_attr :endpoint, nil, ::String, nil
671
692
  config_attr :credentials, nil do |value|
672
693
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
673
694
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -682,6 +703,7 @@ module Google
682
703
  config_attr :metadata, nil, ::Hash, nil
683
704
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
684
705
  config_attr :quota_project, nil, ::String, nil
706
+ config_attr :universe_domain, nil, ::String, nil
685
707
 
686
708
  # @private
687
709
  def initialize parent_config = nil
data/lib/google/cloud/data_catalog/v1/data_catalog/rest/client.rb CHANGED
@@ -34,6 +34,9 @@ module Google
34
34
  # your data.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "datacatalog.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -99,6 +102,15 @@ module Google
99
102
  @config
100
103
  end
101
104
 
105
+ ##
106
+ # The effective universe domain
107
+ #
108
+ # @return [String]
109
+ #
110
+ def universe_domain
111
+ @data_catalog_stub.universe_domain
112
+ end
113
+
102
114
  ##
103
115
  # Create a new DataCatalog REST client object.
104
116
  #
@@ -126,8 +138,9 @@ module Google
126
138
  credentials = @config.credentials
127
139
  # Use self-signed JWT if the endpoint is unchanged from default,
128
140
  # but only if the default endpoint does not have a region prefix.
129
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
130
- !@config.endpoint.split(".").first.include?("-")
141
+ enable_self_signed_jwt = @config.endpoint.nil? ||
142
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
143
+ !@config.endpoint.split(".").first.include?("-"))
131
144
  credentials ||= Credentials.default scope: @config.scope,
132
145
  enable_self_signed_jwt: enable_self_signed_jwt
133
146
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -141,15 +154,22 @@ module Google
141
154
  config.credentials = credentials
142
155
  config.quota_project = @quota_project_id
143
156
  config.endpoint = @config.endpoint
157
+ config.universe_domain = @config.universe_domain
144
158
  end
145
159
 
146
160
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
147
161
  config.credentials = credentials
148
162
  config.quota_project = @quota_project_id
149
163
  config.endpoint = @config.endpoint
164
+ config.universe_domain = @config.universe_domain
150
165
  end
151
166
 
152
- @data_catalog_stub = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
167
+ @data_catalog_stub = ::Google::Cloud::DataCatalog::V1::DataCatalog::Rest::ServiceStub.new(
168
+ endpoint: @config.endpoint,
169
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
170
+ universe_domain: @config.universe_domain,
171
+ credentials: credentials
172
+ )
153
173
  end
154
174
 
155
175
  ##
@@ -3424,9 +3444,9 @@ module Google
3424
3444
  # end
3425
3445
  #
3426
3446
  # @!attribute [rw] endpoint
3427
- # The hostname or hostname:port of the service endpoint.
3428
- # Defaults to `"datacatalog.googleapis.com"`.
3429
- # @return [::String]
3447
+ # A custom service endpoint, as a hostname or hostname:port. The default is
3448
+ # nil, indicating to use the default endpoint in the current universe domain.
3449
+ # @return [::String,nil]
3430
3450
  # @!attribute [rw] credentials
3431
3451
  # Credentials to send with calls. You may provide any of the following types:
3432
3452
  # * (`String`) The path to a service account key file in JSON format
@@ -3463,13 +3483,20 @@ module Google
3463
3483
  # @!attribute [rw] quota_project
3464
3484
  # A separate project against which to charge quota.
3465
3485
  # @return [::String]
3486
+ # @!attribute [rw] universe_domain
3487
+ # The universe domain within which to make requests. This determines the
3488
+ # default endpoint URL. The default value of nil uses the environment
3489
+ # universe (usually the default "googleapis.com" universe).
3490
+ # @return [::String,nil]
3466
3491
  #
3467
3492
  class Configuration
3468
3493
  extend ::Gapic::Config
3469
3494
 
3495
+ # @private
3496
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3470
3497
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
3471
3498
 
3472
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3499
+ config_attr :endpoint, nil, ::String, nil
3473
3500
  config_attr :credentials, nil do |value|
3474
3501
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3475
3502
  allowed.any? { |klass| klass === value }
@@ -3481,6 +3508,7 @@ module Google
3481
3508
  config_attr :metadata, nil, ::Hash, nil
3482
3509
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3483
3510
  config_attr :quota_project, nil, ::String, nil
3511
+ config_attr :universe_domain, nil, ::String, nil
3484
3512
 
3485
3513
  # @private
3486
3514
  def initialize parent_config = nil
data/lib/google/cloud/data_catalog/v1/data_catalog/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 = "datacatalog.$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
@@ -478,9 +492,9 @@ module Google
478
492
  # end
479
493
  #
480
494
  # @!attribute [rw] endpoint
481
- # The hostname or hostname:port of the service endpoint.
482
- # Defaults to `"datacatalog.googleapis.com"`.
483
- # @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]
484
498
  # @!attribute [rw] credentials
485
499
  # Credentials to send with calls. You may provide any of the following types:
486
500
  # * (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
517
531
  # @!attribute [rw] quota_project
518
532
  # A separate project against which to charge quota.
519
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]
520
539
  #
521
540
  class Configuration
522
541
  extend ::Gapic::Config
523
542
 
543
+ # @private
544
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
524
545
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
525
546
 
526
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
547
+ config_attr :endpoint, nil, ::String, nil
527
548
  config_attr :credentials, nil do |value|
528
549
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
529
550
  allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
535
556
  config_attr :metadata, nil, ::Hash, nil
536
557
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
537
558
  config_attr :quota_project, nil, ::String, nil
559
+ config_attr :universe_domain, nil, ::String, nil
538
560
 
539
561
  # @private
540
562
  def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
617
639
  # Service stub contains baseline method implementations
618
640
  # including transcoding, making the REST call, and deserialing the response.
619
641
  class OperationsServiceStub
620
- def initialize endpoint:, credentials:
642
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
621
643
  # These require statements are intentionally placed here to initialize
622
644
  # the REST modules only when it's required.
623
645
  require "gapic/rest"
624
646
 
625
- @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
626
651
  end
627
652
 
628
653
  ##