google-cloud-data_catalog-v1beta1 0.2.1 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 71be6d3301331cdba29db8e77648eb56a6c5e49fb34d3ca29aff3dc56a9f82d8
4
- data.tar.gz: b88107a1c4fa97f661d5db65127c7b4b213ec5cea06ce51b70d1b4452f270be2
3
+ metadata.gz: 2af6fcf5e374e46b9a95a089b4707a9b56a72bb31951972864d17feee37ae6f7
4
+ data.tar.gz: 1d55622e1eb39823db7dd4ccb61ef8c59bd300dfb9259f624e46d17f6f9547d3
5
5
  SHA512:
6
- metadata.gz: 9267cea730bbc5ead69ce6ff7a2bb44987da3fb87b5398967417e84ed6c9e2e022f14ec24b354e0ab865890f39c3ac00022a84bdb7dfbb48e1889a19d46f354c
7
- data.tar.gz: 597380e57a0380bc545f8ac38d6254846e4761d15c236ebd6f1cac2509ed20090092650dc53b8d719078208932f16a519ed9931b5c665767e7c882621447509a
6
+ metadata.gz: 50b7420cede76e42e1ba2f97023bee1e9fff357532024c77e8a1eb7e5f63f0bfc639abccdb1b9749a84621e5833ca991c0b2b20f6b1b46fae13c61f69373c8d1
7
+ data.tar.gz: aefa0ac8d9b734ec453fa4fa14540f3e1394d89c96c9c6a96cb9f48d770aca5fc34cb6ff9955f72402cae9a1cdee250bc2f89788a35fbfb0020e562cce0d1549
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-data_catalog-v1beta1 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-v1beta1 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/data_catalog/v1beta1"
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::V1beta1::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-v1beta1 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-v1beta1 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-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::DataCatalog::V1beta1::DataCatalog::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/data_catalog/v1beta1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::DataCatalog::V1beta1::DataCatalog::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/data_catalog/v1beta1"
88
58
 
89
59
  client = ::Google::Cloud::DataCatalog::V1beta1::DataCatalog::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/data_catalog/v1beta1"
98
68
 
99
69
  ::Google::Cloud::DataCatalog::V1beta1::DataCatalog::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::DataCatalog::V1beta1::DataCatalog::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-data_catalog-v1beta1
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/data_catalog/v1beta1"
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-data_catalog-v1beta1.
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::DataCatalog::V1beta1::DataCatalog::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
  # their 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,12 +157,15 @@ 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
  @data_catalog_stub = ::Gapic::ServiceStub.new(
150
164
  ::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Stub,
151
- credentials: credentials,
152
- endpoint: @config.endpoint,
165
+ credentials: credentials,
166
+ endpoint: @config.endpoint,
167
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
168
+ universe_domain: @config.universe_domain,
153
169
  channel_args: @config.channel_args,
154
170
  interceptors: @config.interceptors,
155
171
  channel_pool_config: @config.channel_pool
@@ -2976,9 +2992,9 @@ module Google
2976
2992
  # end
2977
2993
  #
2978
2994
  # @!attribute [rw] endpoint
2979
- # The hostname or hostname:port of the service endpoint.
2980
- # Defaults to `"datacatalog.googleapis.com"`.
2981
- # @return [::String]
2995
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2996
+ # nil, indicating to use the default endpoint in the current universe domain.
2997
+ # @return [::String,nil]
2982
2998
  # @!attribute [rw] credentials
2983
2999
  # Credentials to send with calls. You may provide any of the following types:
2984
3000
  # * (`String`) The path to a service account key file in JSON format
@@ -3024,13 +3040,20 @@ module Google
3024
3040
  # @!attribute [rw] quota_project
3025
3041
  # A separate project against which to charge quota.
3026
3042
  # @return [::String]
3043
+ # @!attribute [rw] universe_domain
3044
+ # The universe domain within which to make requests. This determines the
3045
+ # default endpoint URL. The default value of nil uses the environment
3046
+ # universe (usually the default "googleapis.com" universe).
3047
+ # @return [::String,nil]
3027
3048
  #
3028
3049
  class Configuration
3029
3050
  extend ::Gapic::Config
3030
3051
 
3052
+ # @private
3053
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
3031
3054
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
3032
3055
 
3033
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
3056
+ config_attr :endpoint, nil, ::String, nil
3034
3057
  config_attr :credentials, nil do |value|
3035
3058
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
3036
3059
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -3045,6 +3068,7 @@ module Google
3045
3068
  config_attr :metadata, nil, ::Hash, nil
3046
3069
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
3047
3070
  config_attr :quota_project, nil, ::String, nil
3071
+ config_attr :universe_domain, nil, ::String, nil
3048
3072
 
3049
3073
  # @private
3050
3074
  def initialize parent_config = nil
@@ -34,6 +34,9 @@ module Google
34
34
  # their 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,9 +154,15 @@ 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
- @data_catalog_stub = ::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
160
+ @data_catalog_stub = ::Google::Cloud::DataCatalog::V1beta1::DataCatalog::Rest::ServiceStub.new(
161
+ endpoint: @config.endpoint,
162
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
163
+ universe_domain: @config.universe_domain,
164
+ credentials: credentials
165
+ )
147
166
  end
148
167
 
149
168
  ##
@@ -2785,9 +2804,9 @@ module Google
2785
2804
  # end
2786
2805
  #
2787
2806
  # @!attribute [rw] endpoint
2788
- # The hostname or hostname:port of the service endpoint.
2789
- # Defaults to `"datacatalog.googleapis.com"`.
2790
- # @return [::String]
2807
+ # A custom service endpoint, as a hostname or hostname:port. The default is
2808
+ # nil, indicating to use the default endpoint in the current universe domain.
2809
+ # @return [::String,nil]
2791
2810
  # @!attribute [rw] credentials
2792
2811
  # Credentials to send with calls. You may provide any of the following types:
2793
2812
  # * (`String`) The path to a service account key file in JSON format
@@ -2824,13 +2843,20 @@ module Google
2824
2843
  # @!attribute [rw] quota_project
2825
2844
  # A separate project against which to charge quota.
2826
2845
  # @return [::String]
2846
+ # @!attribute [rw] universe_domain
2847
+ # The universe domain within which to make requests. This determines the
2848
+ # default endpoint URL. The default value of nil uses the environment
2849
+ # universe (usually the default "googleapis.com" universe).
2850
+ # @return [::String,nil]
2827
2851
  #
2828
2852
  class Configuration
2829
2853
  extend ::Gapic::Config
2830
2854
 
2855
+ # @private
2856
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
2831
2857
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
2832
2858
 
2833
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
2859
+ config_attr :endpoint, nil, ::String, nil
2834
2860
  config_attr :credentials, nil do |value|
2835
2861
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
2836
2862
  allowed.any? { |klass| klass === value }
@@ -2842,6 +2868,7 @@ module Google
2842
2868
  config_attr :metadata, nil, ::Hash, nil
2843
2869
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2844
2870
  config_attr :quota_project, nil, ::String, nil
2871
+ config_attr :universe_domain, nil, ::String, nil
2845
2872
 
2846
2873
  # @private
2847
2874
  def initialize parent_config = nil
@@ -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: false,
40
43
  raise_faraday_errors: false
41
44
  end
42
45
 
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
43
55
  ##
44
56
  # Baseline implementation for the search_catalog REST call
45
57
  #
@@ -32,6 +32,9 @@ module Google
32
32
  # and policy tags.
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
@@ -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
+ @policy_tag_manager_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new PolicyTagManager 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,12 +154,15 @@ 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
  @policy_tag_manager_stub = ::Gapic::ServiceStub.new(
147
161
  ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Stub,
148
- credentials: credentials,
149
- endpoint: @config.endpoint,
162
+ credentials: credentials,
163
+ endpoint: @config.endpoint,
164
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
165
+ universe_domain: @config.universe_domain,
150
166
  channel_args: @config.channel_args,
151
167
  interceptors: @config.interceptors,
152
168
  channel_pool_config: @config.channel_pool
@@ -1368,9 +1384,9 @@ module Google
1368
1384
  # end
1369
1385
  #
1370
1386
  # @!attribute [rw] endpoint
1371
- # The hostname or hostname:port of the service endpoint.
1372
- # Defaults to `"datacatalog.googleapis.com"`.
1373
- # @return [::String]
1387
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1388
+ # nil, indicating to use the default endpoint in the current universe domain.
1389
+ # @return [::String,nil]
1374
1390
  # @!attribute [rw] credentials
1375
1391
  # Credentials to send with calls. You may provide any of the following types:
1376
1392
  # * (`String`) The path to a service account key file in JSON format
@@ -1416,13 +1432,20 @@ module Google
1416
1432
  # @!attribute [rw] quota_project
1417
1433
  # A separate project against which to charge quota.
1418
1434
  # @return [::String]
1435
+ # @!attribute [rw] universe_domain
1436
+ # The universe domain within which to make requests. This determines the
1437
+ # default endpoint URL. The default value of nil uses the environment
1438
+ # universe (usually the default "googleapis.com" universe).
1439
+ # @return [::String,nil]
1419
1440
  #
1420
1441
  class Configuration
1421
1442
  extend ::Gapic::Config
1422
1443
 
1444
+ # @private
1445
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1423
1446
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
1424
1447
 
1425
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1448
+ config_attr :endpoint, nil, ::String, nil
1426
1449
  config_attr :credentials, nil do |value|
1427
1450
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1428
1451
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1437,6 +1460,7 @@ module Google
1437
1460
  config_attr :metadata, nil, ::Hash, nil
1438
1461
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1439
1462
  config_attr :quota_project, nil, ::String, nil
1463
+ config_attr :universe_domain, nil, ::String, nil
1440
1464
 
1441
1465
  # @private
1442
1466
  def initialize parent_config = nil
@@ -34,6 +34,9 @@ module Google
34
34
  # and policy tags.
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
@@ -96,6 +99,15 @@ module Google
96
99
  @config
97
100
  end
98
101
 
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @policy_tag_manager_stub.universe_domain
109
+ end
110
+
99
111
  ##
100
112
  # Create a new PolicyTagManager REST client object.
101
113
  #
@@ -123,8 +135,9 @@ module Google
123
135
  credentials = @config.credentials
124
136
  # Use self-signed JWT if the endpoint is unchanged from default,
125
137
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
- !@config.endpoint.split(".").first.include?("-")
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
128
141
  credentials ||= Credentials.default scope: @config.scope,
129
142
  enable_self_signed_jwt: enable_self_signed_jwt
130
143
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -138,9 +151,15 @@ module Google
138
151
  config.credentials = credentials
139
152
  config.quota_project = @quota_project_id
140
153
  config.endpoint = @config.endpoint
154
+ config.universe_domain = @config.universe_domain
141
155
  end
142
156
 
143
- @policy_tag_manager_stub = ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
157
+ @policy_tag_manager_stub = ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManager::Rest::ServiceStub.new(
158
+ endpoint: @config.endpoint,
159
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
160
+ universe_domain: @config.universe_domain,
161
+ credentials: credentials
162
+ )
144
163
  end
145
164
 
146
165
  ##
@@ -1267,9 +1286,9 @@ module Google
1267
1286
  # end
1268
1287
  #
1269
1288
  # @!attribute [rw] endpoint
1270
- # The hostname or hostname:port of the service endpoint.
1271
- # Defaults to `"datacatalog.googleapis.com"`.
1272
- # @return [::String]
1289
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1290
+ # nil, indicating to use the default endpoint in the current universe domain.
1291
+ # @return [::String,nil]
1273
1292
  # @!attribute [rw] credentials
1274
1293
  # Credentials to send with calls. You may provide any of the following types:
1275
1294
  # * (`String`) The path to a service account key file in JSON format
@@ -1306,13 +1325,20 @@ module Google
1306
1325
  # @!attribute [rw] quota_project
1307
1326
  # A separate project against which to charge quota.
1308
1327
  # @return [::String]
1328
+ # @!attribute [rw] universe_domain
1329
+ # The universe domain within which to make requests. This determines the
1330
+ # default endpoint URL. The default value of nil uses the environment
1331
+ # universe (usually the default "googleapis.com" universe).
1332
+ # @return [::String,nil]
1309
1333
  #
1310
1334
  class Configuration
1311
1335
  extend ::Gapic::Config
1312
1336
 
1337
+ # @private
1338
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1313
1339
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
1314
1340
 
1315
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1341
+ config_attr :endpoint, nil, ::String, nil
1316
1342
  config_attr :credentials, nil do |value|
1317
1343
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1318
1344
  allowed.any? { |klass| klass === value }
@@ -1324,6 +1350,7 @@ module Google
1324
1350
  config_attr :metadata, nil, ::Hash, nil
1325
1351
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1326
1352
  config_attr :quota_project, nil, ::String, nil
1353
+ config_attr :universe_domain, nil, ::String, nil
1327
1354
 
1328
1355
  # @private
1329
1356
  def initialize parent_config = nil
@@ -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: false,
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_taxonomy REST call
45
57
  #
@@ -32,6 +32,9 @@ module Google
32
32
  # their taxonomies and policy tags data with serialized format.
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
@@ -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
+ @policy_tag_manager_serialization_stub.universe_domain
107
+ end
108
+
97
109
  ##
98
110
  # Create a new PolicyTagManagerSerialization 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,12 +154,15 @@ 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
  @policy_tag_manager_serialization_stub = ::Gapic::ServiceStub.new(
147
161
  ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Stub,
148
- credentials: credentials,
149
- endpoint: @config.endpoint,
162
+ credentials: credentials,
163
+ endpoint: @config.endpoint,
164
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
165
+ universe_domain: @config.universe_domain,
150
166
  channel_args: @config.channel_args,
151
167
  interceptors: @config.interceptors,
152
168
  channel_pool_config: @config.channel_pool
@@ -377,9 +393,9 @@ module Google
377
393
  # end
378
394
  #
379
395
  # @!attribute [rw] endpoint
380
- # The hostname or hostname:port of the service endpoint.
381
- # Defaults to `"datacatalog.googleapis.com"`.
382
- # @return [::String]
396
+ # A custom service endpoint, as a hostname or hostname:port. The default is
397
+ # nil, indicating to use the default endpoint in the current universe domain.
398
+ # @return [::String,nil]
383
399
  # @!attribute [rw] credentials
384
400
  # Credentials to send with calls. You may provide any of the following types:
385
401
  # * (`String`) The path to a service account key file in JSON format
@@ -425,13 +441,20 @@ module Google
425
441
  # @!attribute [rw] quota_project
426
442
  # A separate project against which to charge quota.
427
443
  # @return [::String]
444
+ # @!attribute [rw] universe_domain
445
+ # The universe domain within which to make requests. This determines the
446
+ # default endpoint URL. The default value of nil uses the environment
447
+ # universe (usually the default "googleapis.com" universe).
448
+ # @return [::String,nil]
428
449
  #
429
450
  class Configuration
430
451
  extend ::Gapic::Config
431
452
 
453
+ # @private
454
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
432
455
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
433
456
 
434
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
457
+ config_attr :endpoint, nil, ::String, nil
435
458
  config_attr :credentials, nil do |value|
436
459
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
437
460
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -446,6 +469,7 @@ module Google
446
469
  config_attr :metadata, nil, ::Hash, nil
447
470
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
448
471
  config_attr :quota_project, nil, ::String, nil
472
+ config_attr :universe_domain, nil, ::String, nil
449
473
 
450
474
  # @private
451
475
  def initialize parent_config = nil
@@ -34,6 +34,9 @@ module Google
34
34
  # their taxonomies and policy tags data with serialized format.
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
@@ -96,6 +99,15 @@ module Google
96
99
  @config
97
100
  end
98
101
 
102
+ ##
103
+ # The effective universe domain
104
+ #
105
+ # @return [String]
106
+ #
107
+ def universe_domain
108
+ @policy_tag_manager_serialization_stub.universe_domain
109
+ end
110
+
99
111
  ##
100
112
  # Create a new PolicyTagManagerSerialization REST client object.
101
113
  #
@@ -123,8 +135,9 @@ module Google
123
135
  credentials = @config.credentials
124
136
  # Use self-signed JWT if the endpoint is unchanged from default,
125
137
  # but only if the default endpoint does not have a region prefix.
126
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
127
- !@config.endpoint.split(".").first.include?("-")
138
+ enable_self_signed_jwt = @config.endpoint.nil? ||
139
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
140
+ !@config.endpoint.split(".").first.include?("-"))
128
141
  credentials ||= Credentials.default scope: @config.scope,
129
142
  enable_self_signed_jwt: enable_self_signed_jwt
130
143
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -138,9 +151,15 @@ module Google
138
151
  config.credentials = credentials
139
152
  config.quota_project = @quota_project_id
140
153
  config.endpoint = @config.endpoint
154
+ config.universe_domain = @config.universe_domain
141
155
  end
142
156
 
143
- @policy_tag_manager_serialization_stub = ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
157
+ @policy_tag_manager_serialization_stub = ::Google::Cloud::DataCatalog::V1beta1::PolicyTagManagerSerialization::Rest::ServiceStub.new(
158
+ endpoint: @config.endpoint,
159
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
160
+ universe_domain: @config.universe_domain,
161
+ credentials: credentials
162
+ )
144
163
  end
145
164
 
146
165
  ##
@@ -353,9 +372,9 @@ module Google
353
372
  # end
354
373
  #
355
374
  # @!attribute [rw] endpoint
356
- # The hostname or hostname:port of the service endpoint.
357
- # Defaults to `"datacatalog.googleapis.com"`.
358
- # @return [::String]
375
+ # A custom service endpoint, as a hostname or hostname:port. The default is
376
+ # nil, indicating to use the default endpoint in the current universe domain.
377
+ # @return [::String,nil]
359
378
  # @!attribute [rw] credentials
360
379
  # Credentials to send with calls. You may provide any of the following types:
361
380
  # * (`String`) The path to a service account key file in JSON format
@@ -392,13 +411,20 @@ module Google
392
411
  # @!attribute [rw] quota_project
393
412
  # A separate project against which to charge quota.
394
413
  # @return [::String]
414
+ # @!attribute [rw] universe_domain
415
+ # The universe domain within which to make requests. This determines the
416
+ # default endpoint URL. The default value of nil uses the environment
417
+ # universe (usually the default "googleapis.com" universe).
418
+ # @return [::String,nil]
395
419
  #
396
420
  class Configuration
397
421
  extend ::Gapic::Config
398
422
 
423
+ # @private
424
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
399
425
  DEFAULT_ENDPOINT = "datacatalog.googleapis.com"
400
426
 
401
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
427
+ config_attr :endpoint, nil, ::String, nil
402
428
  config_attr :credentials, nil do |value|
403
429
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
404
430
  allowed.any? { |klass| klass === value }
@@ -410,6 +436,7 @@ module Google
410
436
  config_attr :metadata, nil, ::Hash, nil
411
437
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
412
438
  config_attr :quota_project, nil, ::String, nil
439
+ config_attr :universe_domain, nil, ::String, nil
413
440
 
414
441
  # @private
415
442
  def initialize parent_config = nil
@@ -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: false,
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 import_taxonomies REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module DataCatalog
23
23
  module V1beta1
24
- VERSION = "0.2.1"
24
+ VERSION = "0.3.0"
25
25
  end
26
26
  end
27
27
  end
@@ -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-data_catalog-v1beta1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.3.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-09 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