google-cloud-dataplex-v1 0.17.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/lib/google/cloud/dataplex/v1/content_service/client.rb +33 -8
  4. data/lib/google/cloud/dataplex/v1/content_service/rest/client.rb +35 -7
  5. data/lib/google/cloud/dataplex/v1/content_service/rest/service_stub.rb +14 -2
  6. data/lib/google/cloud/dataplex/v1/data_scan_service/client.rb +34 -8
  7. data/lib/google/cloud/dataplex/v1/data_scan_service/operations.rb +28 -6
  8. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/client.rb +36 -7
  9. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/operations.rb +33 -8
  10. data/lib/google/cloud/dataplex/v1/data_scan_service/rest/service_stub.rb +14 -2
  11. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/client.rb +34 -8
  12. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/operations.rb +28 -6
  13. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/client.rb +36 -7
  14. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/operations.rb +33 -8
  15. data/lib/google/cloud/dataplex/v1/data_taxonomy_service/rest/service_stub.rb +14 -2
  16. data/lib/google/cloud/dataplex/v1/dataplex_service/client.rb +34 -8
  17. data/lib/google/cloud/dataplex/v1/dataplex_service/operations.rb +28 -6
  18. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/client.rb +36 -7
  19. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/operations.rb +33 -8
  20. data/lib/google/cloud/dataplex/v1/dataplex_service/rest/service_stub.rb +14 -2
  21. data/lib/google/cloud/dataplex/v1/metadata_service/client.rb +33 -8
  22. data/lib/google/cloud/dataplex/v1/metadata_service/rest/client.rb +35 -7
  23. data/lib/google/cloud/dataplex/v1/metadata_service/rest/service_stub.rb +14 -2
  24. data/lib/google/cloud/dataplex/v1/version.rb +1 -1
  25. data/proto_docs/google/api/client.rb +1 -0
  26. data/proto_docs/google/cloud/dataplex/v1/data_quality.rb +6 -1
  27. data/proto_docs/google/cloud/dataplex/v1/metadata.rb +2 -0
  28. metadata +8 -8
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cce062a38692dfa50e757abc9cdc6d24395816594c1d9f911e92192b434681f9
4
- data.tar.gz: 2d59a7764faa0fb2a324f8bd33907f4541aa199bc974dcbf99bc229075697c7d
3
+ metadata.gz: 468ab22b28a7398caa85a638be3d9f153ae79b82e131636ce3d7d32686d1fa7c
4
+ data.tar.gz: 7734d38122617430a3fe8e60864ca42b23d29414d7dca1fe2e187da8434d427a
5
5
  SHA512:
6
- metadata.gz: 9f676a2759311b50ff4002142f01d59ab3104d39340c675cf4712886aa07e3229d0025fdab0a967dfde83c68c7f8e7d825645415ffb2fea4121d36bb574f8fdc
7
- data.tar.gz: 054e077daa5f2a114928ad137f4490f7a81782e66c6332bcaaf34046aaf4daef5d628bdbb90a24158ca9fda96517d3edfa99f7a0ef456bd235afe81474c9234a
6
+ metadata.gz: 7273db1539298bac732bcbd94cc90d6470cc03dd438477e23a487570a55922b519ccdf3b500cc570b48221c73d590ec242086fa3bc0b92c82ddedad20d92aa0b
7
+ data.tar.gz: cff4831b3e4ac7193768794d22a0b698277782c11373c4a3f0de90ace9b61e3ecd1d052bfe1a0a1b701ff72248d2557860e8342f9679937c876c5876c2caf044
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dataplex-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-dataplex-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 GOOGLE_CLOUD_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/dataplex/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::Dataplex::V1::ContentService::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-dataplex-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-dataplex-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-dataplex-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Dataplex::V1::ContentService::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `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)
72
41
 
73
- ```ruby
74
- require "google/cloud/dataplex/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::Dataplex::V1::ContentService::Client.new
79
- ```
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).
80
49
 
81
- ### 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.
82
53
 
83
- The path to the **Credentials JSON** file can be configured instead of storing
84
- it in an environment variable. Either on an individual client initialization:
54
+ To configure a credentials file for an individual client initialization:
85
55
 
86
56
  ```ruby
87
57
  require "google/cloud/dataplex/v1"
88
58
 
89
59
  client = ::Google::Cloud::Dataplex::V1::ContentService::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/dataplex/v1"
98
68
 
99
69
  ::Google::Cloud::Dataplex::V1::ContentService::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::Dataplex::V1::ContentService::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- 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.
111
82
 
112
- 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).
113
87
 
114
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 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-dataplex-v1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *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
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/dataplex/v1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-dataplex-v1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Dataplex::V1::ContentService::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
132
- 2. Create a new project or click on an existing project.
133
- 3. Activate the menu in the upper left and select **APIs & Services**. From
134
- here, you will enable the APIs that your application requires.
106
+ ### Local ADC file
135
107
 
136
- *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.
137
111
 
138
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- 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.
147
120
 
148
- The key file you download will be used by this library to authenticate API
149
- 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).
@@ -32,6 +32,9 @@ module Google
32
32
  # ContentService manages Notebook and SQL Scripts for Dataplex.
33
33
  #
34
34
  class Client
35
+ # @private
36
+ DEFAULT_ENDPOINT_TEMPLATE = "dataplex.$UNIVERSE_DOMAIN$"
37
+
35
38
  include Paths
36
39
 
37
40
  # @private
@@ -120,6 +123,15 @@ module Google
120
123
  @config
121
124
  end
122
125
 
126
+ ##
127
+ # The effective universe domain
128
+ #
129
+ # @return [String]
130
+ #
131
+ def universe_domain
132
+ @content_service_stub.universe_domain
133
+ end
134
+
123
135
  ##
124
136
  # Create a new ContentService client object.
125
137
  #
@@ -153,8 +165,9 @@ module Google
153
165
  credentials = @config.credentials
154
166
  # Use self-signed JWT if the endpoint is unchanged from default,
155
167
  # but only if the default endpoint does not have a region prefix.
156
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
157
- !@config.endpoint.split(".").first.include?("-")
168
+ enable_self_signed_jwt = @config.endpoint.nil? ||
169
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
170
+ !@config.endpoint.split(".").first.include?("-"))
158
171
  credentials ||= Credentials.default scope: @config.scope,
159
172
  enable_self_signed_jwt: enable_self_signed_jwt
160
173
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -167,18 +180,22 @@ module Google
167
180
  config.credentials = credentials
168
181
  config.quota_project = @quota_project_id
169
182
  config.endpoint = @config.endpoint
183
+ config.universe_domain = @config.universe_domain
170
184
  end
171
185
 
172
186
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
173
187
  config.credentials = credentials
174
188
  config.quota_project = @quota_project_id
175
189
  config.endpoint = @config.endpoint
190
+ config.universe_domain = @config.universe_domain
176
191
  end
177
192
 
178
193
  @content_service_stub = ::Gapic::ServiceStub.new(
179
194
  ::Google::Cloud::Dataplex::V1::ContentService::Stub,
180
- credentials: credentials,
181
- endpoint: @config.endpoint,
195
+ credentials: credentials,
196
+ endpoint: @config.endpoint,
197
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
198
+ universe_domain: @config.universe_domain,
182
199
  channel_args: @config.channel_args,
183
200
  interceptors: @config.interceptors,
184
201
  channel_pool_config: @config.channel_pool
@@ -992,9 +1009,9 @@ module Google
992
1009
  # end
993
1010
  #
994
1011
  # @!attribute [rw] endpoint
995
- # The hostname or hostname:port of the service endpoint.
996
- # Defaults to `"dataplex.googleapis.com"`.
997
- # @return [::String]
1012
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1013
+ # nil, indicating to use the default endpoint in the current universe domain.
1014
+ # @return [::String,nil]
998
1015
  # @!attribute [rw] credentials
999
1016
  # Credentials to send with calls. You may provide any of the following types:
1000
1017
  # * (`String`) The path to a service account key file in JSON format
@@ -1040,13 +1057,20 @@ module Google
1040
1057
  # @!attribute [rw] quota_project
1041
1058
  # A separate project against which to charge quota.
1042
1059
  # @return [::String]
1060
+ # @!attribute [rw] universe_domain
1061
+ # The universe domain within which to make requests. This determines the
1062
+ # default endpoint URL. The default value of nil uses the environment
1063
+ # universe (usually the default "googleapis.com" universe).
1064
+ # @return [::String,nil]
1043
1065
  #
1044
1066
  class Configuration
1045
1067
  extend ::Gapic::Config
1046
1068
 
1069
+ # @private
1070
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1047
1071
  DEFAULT_ENDPOINT = "dataplex.googleapis.com"
1048
1072
 
1049
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1073
+ config_attr :endpoint, nil, ::String, nil
1050
1074
  config_attr :credentials, nil do |value|
1051
1075
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1052
1076
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1061,6 +1085,7 @@ module Google
1061
1085
  config_attr :metadata, nil, ::Hash, nil
1062
1086
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1063
1087
  config_attr :quota_project, nil, ::String, nil
1088
+ config_attr :universe_domain, nil, ::String, nil
1064
1089
 
1065
1090
  # @private
1066
1091
  def initialize parent_config = nil
@@ -34,6 +34,9 @@ module Google
34
34
  # ContentService manages Notebook and SQL Scripts for Dataplex.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "dataplex.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -122,6 +125,15 @@ module Google
122
125
  @config
123
126
  end
124
127
 
128
+ ##
129
+ # The effective universe domain
130
+ #
131
+ # @return [String]
132
+ #
133
+ def universe_domain
134
+ @content_service_stub.universe_domain
135
+ end
136
+
125
137
  ##
126
138
  # Create a new ContentService REST client object.
127
139
  #
@@ -149,8 +161,9 @@ module Google
149
161
  credentials = @config.credentials
150
162
  # Use self-signed JWT if the endpoint is unchanged from default,
151
163
  # but only if the default endpoint does not have a region prefix.
152
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
153
- !@config.endpoint.split(".").first.include?("-")
164
+ enable_self_signed_jwt = @config.endpoint.nil? ||
165
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
166
+ !@config.endpoint.split(".").first.include?("-"))
154
167
  credentials ||= Credentials.default scope: @config.scope,
155
168
  enable_self_signed_jwt: enable_self_signed_jwt
156
169
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -164,6 +177,7 @@ module Google
164
177
  config.credentials = credentials
165
178
  config.quota_project = @quota_project_id
166
179
  config.endpoint = @config.endpoint
180
+ config.universe_domain = @config.universe_domain
167
181
  config.bindings_override = @config.bindings_override
168
182
  end
169
183
 
@@ -171,10 +185,16 @@ module Google
171
185
  config.credentials = credentials
172
186
  config.quota_project = @quota_project_id
173
187
  config.endpoint = @config.endpoint
188
+ config.universe_domain = @config.universe_domain
174
189
  config.bindings_override = @config.bindings_override
175
190
  end
176
191
 
177
- @content_service_stub = ::Google::Cloud::Dataplex::V1::ContentService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
192
+ @content_service_stub = ::Google::Cloud::Dataplex::V1::ContentService::Rest::ServiceStub.new(
193
+ endpoint: @config.endpoint,
194
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
195
+ universe_domain: @config.universe_domain,
196
+ credentials: credentials
197
+ )
178
198
  end
179
199
 
180
200
  ##
@@ -928,9 +948,9 @@ module Google
928
948
  # end
929
949
  #
930
950
  # @!attribute [rw] endpoint
931
- # The hostname or hostname:port of the service endpoint.
932
- # Defaults to `"dataplex.googleapis.com"`.
933
- # @return [::String]
951
+ # A custom service endpoint, as a hostname or hostname:port. The default is
952
+ # nil, indicating to use the default endpoint in the current universe domain.
953
+ # @return [::String,nil]
934
954
  # @!attribute [rw] credentials
935
955
  # Credentials to send with calls. You may provide any of the following types:
936
956
  # * (`String`) The path to a service account key file in JSON format
@@ -967,13 +987,20 @@ module Google
967
987
  # @!attribute [rw] quota_project
968
988
  # A separate project against which to charge quota.
969
989
  # @return [::String]
990
+ # @!attribute [rw] universe_domain
991
+ # The universe domain within which to make requests. This determines the
992
+ # default endpoint URL. The default value of nil uses the environment
993
+ # universe (usually the default "googleapis.com" universe).
994
+ # @return [::String,nil]
970
995
  #
971
996
  class Configuration
972
997
  extend ::Gapic::Config
973
998
 
999
+ # @private
1000
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
974
1001
  DEFAULT_ENDPOINT = "dataplex.googleapis.com"
975
1002
 
976
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1003
+ config_attr :endpoint, nil, ::String, nil
977
1004
  config_attr :credentials, nil do |value|
978
1005
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
979
1006
  allowed.any? { |klass| klass === value }
@@ -985,6 +1012,7 @@ module Google
985
1012
  config_attr :metadata, nil, ::Hash, nil
986
1013
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
987
1014
  config_attr :quota_project, nil, ::String, nil
1015
+ config_attr :universe_domain, nil, ::String, nil
988
1016
 
989
1017
  # @private
990
1018
  # Overrides for http bindings for the RPCs of this service
@@ -30,16 +30,28 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, credentials:
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
34
  # These require statements are intentionally placed here to initialize
35
35
  # the REST modules only when it's required.
36
36
  require "gapic/rest"
37
37
 
38
- @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
39
42
  numeric_enums: true,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the create_content REST call
45
57
  #
@@ -34,6 +34,9 @@ module Google
34
34
  # Data Profile, Data Quality) for the data source.
35
35
  #
36
36
  class Client
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "dataplex.$UNIVERSE_DOMAIN$"
39
+
37
40
  include Paths
38
41
 
39
42
  # @private
@@ -94,6 +97,15 @@ module Google
94
97
  @config
95
98
  end
96
99
 
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @data_scan_service_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new DataScanService client object.
99
111
  #
@@ -127,8 +139,9 @@ module Google
127
139
  credentials = @config.credentials
128
140
  # Use self-signed JWT if the endpoint is unchanged from default,
129
141
  # but only if the default endpoint does not have a region prefix.
130
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
131
- !@config.endpoint.split(".").first.include?("-")
142
+ enable_self_signed_jwt = @config.endpoint.nil? ||
143
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
144
+ !@config.endpoint.split(".").first.include?("-"))
132
145
  credentials ||= Credentials.default scope: @config.scope,
133
146
  enable_self_signed_jwt: enable_self_signed_jwt
134
147
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -141,24 +154,29 @@ 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
  @location_client = Google::Cloud::Location::Locations::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
167
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
153
168
  config.credentials = credentials
154
169
  config.quota_project = @quota_project_id
155
170
  config.endpoint = @config.endpoint
171
+ config.universe_domain = @config.universe_domain
156
172
  end
157
173
 
158
174
  @data_scan_service_stub = ::Gapic::ServiceStub.new(
159
175
  ::Google::Cloud::Dataplex::V1::DataScanService::Stub,
160
- credentials: credentials,
161
- endpoint: @config.endpoint,
176
+ credentials: credentials,
177
+ endpoint: @config.endpoint,
178
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
179
+ universe_domain: @config.universe_domain,
162
180
  channel_args: @config.channel_args,
163
181
  interceptors: @config.interceptors,
164
182
  channel_pool_config: @config.channel_pool
@@ -1021,9 +1039,9 @@ module Google
1021
1039
  # end
1022
1040
  #
1023
1041
  # @!attribute [rw] endpoint
1024
- # The hostname or hostname:port of the service endpoint.
1025
- # Defaults to `"dataplex.googleapis.com"`.
1026
- # @return [::String]
1042
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1043
+ # nil, indicating to use the default endpoint in the current universe domain.
1044
+ # @return [::String,nil]
1027
1045
  # @!attribute [rw] credentials
1028
1046
  # Credentials to send with calls. You may provide any of the following types:
1029
1047
  # * (`String`) The path to a service account key file in JSON format
@@ -1069,13 +1087,20 @@ module Google
1069
1087
  # @!attribute [rw] quota_project
1070
1088
  # A separate project against which to charge quota.
1071
1089
  # @return [::String]
1090
+ # @!attribute [rw] universe_domain
1091
+ # The universe domain within which to make requests. This determines the
1092
+ # default endpoint URL. The default value of nil uses the environment
1093
+ # universe (usually the default "googleapis.com" universe).
1094
+ # @return [::String,nil]
1072
1095
  #
1073
1096
  class Configuration
1074
1097
  extend ::Gapic::Config
1075
1098
 
1099
+ # @private
1100
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1076
1101
  DEFAULT_ENDPOINT = "dataplex.googleapis.com"
1077
1102
 
1078
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1103
+ config_attr :endpoint, nil, ::String, nil
1079
1104
  config_attr :credentials, nil do |value|
1080
1105
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1081
1106
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1090,6 +1115,7 @@ module Google
1090
1115
  config_attr :metadata, nil, ::Hash, nil
1091
1116
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1092
1117
  config_attr :quota_project, nil, ::String, nil
1118
+ config_attr :universe_domain, nil, ::String, nil
1093
1119
 
1094
1120
  # @private
1095
1121
  def initialize parent_config = nil