google-cloud-secure_source_manager-v1 0.1.0 → 0.2.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e500e7f49f8e35d3f60e4a8860605c64fa4c3d70a0efba10e18c9356ede02322
4
- data.tar.gz: e767299452dbfe7a230f8e6f1eb7dcb4691798a502a3b0e5f01acbcd34ca68f5
3
+ metadata.gz: eff20e91a9d6b23e7dd11a2a542a823c5342402cff61708688e35b3780721a44
4
+ data.tar.gz: 9f2e93cdc0000005c334d55b2ac635cc1701cb01162c68b50880bad9530c9ca8
5
5
  SHA512:
6
- metadata.gz: 1f2d40e1a02e781af0332e8ea38fcf149bedc843e72cd95ee68facf400b8f659541dfb6fddbffe3ea85b10179b8ea863725cab56b888871626dcc781d531611a
7
- data.tar.gz: 2f000ca8a3e26b0109d7e25911c7974a4832c9b5a7b2485447bf71ff6e2271fe1fa2e299508e22c26414dbfd190ce5bf44fe9fae4c842a814f3d8fad7c157e56
6
+ metadata.gz: cda3b657eb51e28634043d1f3cb322c72f6e7da5ffa0ac330ea281d84f5ca7f4f98540c625d19b093ac549239cdc80f9360cc8638b91c75d8de1d61f2dc05211
7
+ data.tar.gz: b79c24d6c5991b7cb3175958e8d791e0aef3faf3e23217d5b964fe110c1e9b927f9b14b8f78d207cd3b6526f9b4ae8f3aab90b8b83bbc4a629fe8c2ed90b9e94
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-secure_source_manager-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-secure_source_manager-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/secure_source_manager/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::SecureSourceManager::V1::SecureSourceManager::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-secure_source_manager-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-secure_source_manager-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-secure_source_manager-v1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::SecureSourceManager::V1::SecureSourceManager::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/secure_source_manager/v1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::SecureSourceManager::V1::SecureSourceManager::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/secure_source_manager/v1"
88
58
 
89
59
  client = ::Google::Cloud::SecureSourceManager::V1::SecureSourceManager::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/secure_source_manager/v1"
98
68
 
99
69
  ::Google::Cloud::SecureSourceManager::V1::SecureSourceManager::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::SecureSourceManager::V1::SecureSourceManager::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-secure_source_manager-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/secure_source_manager/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-secure_source_manager-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::SecureSourceManager::V1::SecureSourceManager::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).
@@ -51,6 +51,9 @@ module Google
51
51
  # `securcesourcemanager.googleapis.com`.
52
52
  #
53
53
  class Client
54
+ # @private
55
+ DEFAULT_ENDPOINT_TEMPLATE = "securesourcemanager.$UNIVERSE_DOMAIN$"
56
+
54
57
  include Paths
55
58
 
56
59
  # @private
@@ -136,6 +139,15 @@ module Google
136
139
  @config
137
140
  end
138
141
 
142
+ ##
143
+ # The effective universe domain
144
+ #
145
+ # @return [String]
146
+ #
147
+ def universe_domain
148
+ @secure_source_manager_stub.universe_domain
149
+ end
150
+
139
151
  ##
140
152
  # Create a new SecureSourceManager client object.
141
153
  #
@@ -169,8 +181,9 @@ module Google
169
181
  credentials = @config.credentials
170
182
  # Use self-signed JWT if the endpoint is unchanged from default,
171
183
  # but only if the default endpoint does not have a region prefix.
172
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
173
- !@config.endpoint.split(".").first.include?("-")
184
+ enable_self_signed_jwt = @config.endpoint.nil? ||
185
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
186
+ !@config.endpoint.split(".").first.include?("-"))
174
187
  credentials ||= Credentials.default scope: @config.scope,
175
188
  enable_self_signed_jwt: enable_self_signed_jwt
176
189
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -183,24 +196,29 @@ module Google
183
196
  config.credentials = credentials
184
197
  config.quota_project = @quota_project_id
185
198
  config.endpoint = @config.endpoint
199
+ config.universe_domain = @config.universe_domain
186
200
  end
187
201
 
188
202
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
189
203
  config.credentials = credentials
190
204
  config.quota_project = @quota_project_id
191
205
  config.endpoint = @config.endpoint
206
+ config.universe_domain = @config.universe_domain
192
207
  end
193
208
 
194
209
  @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config|
195
210
  config.credentials = credentials
196
211
  config.quota_project = @quota_project_id
197
212
  config.endpoint = @config.endpoint
213
+ config.universe_domain = @config.universe_domain
198
214
  end
199
215
 
200
216
  @secure_source_manager_stub = ::Gapic::ServiceStub.new(
201
217
  ::Google::Cloud::SecureSourceManager::V1::SecureSourceManager::Stub,
202
- credentials: credentials,
203
- endpoint: @config.endpoint,
218
+ credentials: credentials,
219
+ endpoint: @config.endpoint,
220
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
221
+ universe_domain: @config.universe_domain,
204
222
  channel_args: @config.channel_args,
205
223
  interceptors: @config.interceptors,
206
224
  channel_pool_config: @config.channel_pool
@@ -1330,9 +1348,9 @@ module Google
1330
1348
  # end
1331
1349
  #
1332
1350
  # @!attribute [rw] endpoint
1333
- # The hostname or hostname:port of the service endpoint.
1334
- # Defaults to `"securesourcemanager.googleapis.com"`.
1335
- # @return [::String]
1351
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1352
+ # nil, indicating to use the default endpoint in the current universe domain.
1353
+ # @return [::String,nil]
1336
1354
  # @!attribute [rw] credentials
1337
1355
  # Credentials to send with calls. You may provide any of the following types:
1338
1356
  # * (`String`) The path to a service account key file in JSON format
@@ -1378,13 +1396,20 @@ module Google
1378
1396
  # @!attribute [rw] quota_project
1379
1397
  # A separate project against which to charge quota.
1380
1398
  # @return [::String]
1399
+ # @!attribute [rw] universe_domain
1400
+ # The universe domain within which to make requests. This determines the
1401
+ # default endpoint URL. The default value of nil uses the environment
1402
+ # universe (usually the default "googleapis.com" universe).
1403
+ # @return [::String,nil]
1381
1404
  #
1382
1405
  class Configuration
1383
1406
  extend ::Gapic::Config
1384
1407
 
1408
+ # @private
1409
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1385
1410
  DEFAULT_ENDPOINT = "securesourcemanager.googleapis.com"
1386
1411
 
1387
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1412
+ config_attr :endpoint, nil, ::String, nil
1388
1413
  config_attr :credentials, nil do |value|
1389
1414
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1390
1415
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -1399,6 +1424,7 @@ module Google
1399
1424
  config_attr :metadata, nil, ::Hash, nil
1400
1425
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1401
1426
  config_attr :quota_project, nil, ::String, nil
1427
+ config_attr :universe_domain, nil, ::String, nil
1402
1428
 
1403
1429
  # @private
1404
1430
  def initialize parent_config = nil
@@ -26,6 +26,9 @@ module Google
26
26
  module SecureSourceManager
27
27
  # Service that implements Longrunning Operations API.
28
28
  class Operations
29
+ # @private
30
+ DEFAULT_ENDPOINT_TEMPLATE = "securesourcemanager.$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 `"securesourcemanager.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 = "securesourcemanager.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
@@ -53,6 +53,9 @@ module Google
53
53
  # `securcesourcemanager.googleapis.com`.
54
54
  #
55
55
  class Client
56
+ # @private
57
+ DEFAULT_ENDPOINT_TEMPLATE = "securesourcemanager.$UNIVERSE_DOMAIN$"
58
+
56
59
  include Paths
57
60
 
58
61
  # @private
@@ -138,6 +141,15 @@ module Google
138
141
  @config
139
142
  end
140
143
 
144
+ ##
145
+ # The effective universe domain
146
+ #
147
+ # @return [String]
148
+ #
149
+ def universe_domain
150
+ @secure_source_manager_stub.universe_domain
151
+ end
152
+
141
153
  ##
142
154
  # Create a new SecureSourceManager REST client object.
143
155
  #
@@ -165,8 +177,9 @@ module Google
165
177
  credentials = @config.credentials
166
178
  # Use self-signed JWT if the endpoint is unchanged from default,
167
179
  # but only if the default endpoint does not have a region prefix.
168
- enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
169
- !@config.endpoint.split(".").first.include?("-")
180
+ enable_self_signed_jwt = @config.endpoint.nil? ||
181
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
182
+ !@config.endpoint.split(".").first.include?("-"))
170
183
  credentials ||= Credentials.default scope: @config.scope,
171
184
  enable_self_signed_jwt: enable_self_signed_jwt
172
185
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -180,12 +193,14 @@ module Google
180
193
  config.credentials = credentials
181
194
  config.quota_project = @quota_project_id
182
195
  config.endpoint = @config.endpoint
196
+ config.universe_domain = @config.universe_domain
183
197
  end
184
198
 
185
199
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
186
200
  config.credentials = credentials
187
201
  config.quota_project = @quota_project_id
188
202
  config.endpoint = @config.endpoint
203
+ config.universe_domain = @config.universe_domain
189
204
  config.bindings_override = @config.bindings_override
190
205
  end
191
206
 
@@ -193,10 +208,16 @@ module Google
193
208
  config.credentials = credentials
194
209
  config.quota_project = @quota_project_id
195
210
  config.endpoint = @config.endpoint
211
+ config.universe_domain = @config.universe_domain
196
212
  config.bindings_override = @config.bindings_override
197
213
  end
198
214
 
199
- @secure_source_manager_stub = ::Google::Cloud::SecureSourceManager::V1::SecureSourceManager::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
215
+ @secure_source_manager_stub = ::Google::Cloud::SecureSourceManager::V1::SecureSourceManager::Rest::ServiceStub.new(
216
+ endpoint: @config.endpoint,
217
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
218
+ universe_domain: @config.universe_domain,
219
+ credentials: credentials
220
+ )
200
221
  end
201
222
 
202
223
  ##
@@ -1244,9 +1265,9 @@ module Google
1244
1265
  # end
1245
1266
  #
1246
1267
  # @!attribute [rw] endpoint
1247
- # The hostname or hostname:port of the service endpoint.
1248
- # Defaults to `"securesourcemanager.googleapis.com"`.
1249
- # @return [::String]
1268
+ # A custom service endpoint, as a hostname or hostname:port. The default is
1269
+ # nil, indicating to use the default endpoint in the current universe domain.
1270
+ # @return [::String,nil]
1250
1271
  # @!attribute [rw] credentials
1251
1272
  # Credentials to send with calls. You may provide any of the following types:
1252
1273
  # * (`String`) The path to a service account key file in JSON format
@@ -1283,13 +1304,20 @@ module Google
1283
1304
  # @!attribute [rw] quota_project
1284
1305
  # A separate project against which to charge quota.
1285
1306
  # @return [::String]
1307
+ # @!attribute [rw] universe_domain
1308
+ # The universe domain within which to make requests. This determines the
1309
+ # default endpoint URL. The default value of nil uses the environment
1310
+ # universe (usually the default "googleapis.com" universe).
1311
+ # @return [::String,nil]
1286
1312
  #
1287
1313
  class Configuration
1288
1314
  extend ::Gapic::Config
1289
1315
 
1316
+ # @private
1317
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
1290
1318
  DEFAULT_ENDPOINT = "securesourcemanager.googleapis.com"
1291
1319
 
1292
- config_attr :endpoint, DEFAULT_ENDPOINT, ::String
1320
+ config_attr :endpoint, nil, ::String, nil
1293
1321
  config_attr :credentials, nil do |value|
1294
1322
  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
1295
1323
  allowed.any? { |klass| klass === value }
@@ -1301,6 +1329,7 @@ module Google
1301
1329
  config_attr :metadata, nil, ::Hash, nil
1302
1330
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1303
1331
  config_attr :quota_project, nil, ::String, nil
1332
+ config_attr :universe_domain, nil, ::String, nil
1304
1333
 
1305
1334
  # @private
1306
1335
  # Overrides for http bindings for the RPCs of this service
@@ -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 = "securesourcemanager.$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 `"securesourcemanager.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 = "securesourcemanager.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
  ##
@@ -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 list_instances REST call
45
57
  #
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module SecureSourceManager
23
23
  module V1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.2.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-secure_source_manager-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.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-08 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
@@ -70,7 +70,7 @@ dependencies:
70
70
  requirements:
71
71
  - - ">="
72
72
  - !ruby/object:Gem::Version
73
- version: '0.4'
73
+ version: '0.7'
74
74
  - - "<"
75
75
  - !ruby/object:Gem::Version
76
76
  version: 2.a
@@ -80,7 +80,7 @@ dependencies:
80
80
  requirements:
81
81
  - - ">="
82
82
  - !ruby/object:Gem::Version
83
- version: '0.4'
83
+ version: '0.7'
84
84
  - - "<"
85
85
  - !ruby/object:Gem::Version
86
86
  version: 2.a