google-cloud-kms-inventory-v1 0.7.0 → 0.8.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 +4 -4
- data/AUTHENTICATION.md +72 -99
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/client.rb +31 -8
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/rest/client.rb +33 -7
- data/lib/google/cloud/kms/inventory/v1/key_dashboard_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/client.rb +31 -8
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/client.rb +33 -7
- data/lib/google/cloud/kms/inventory/v1/key_tracking_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/kms/inventory/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- metadata +5 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 67d45287f38ea46c6ed4989e0e6c65a7241e073cbcf0527243f4dc1bd4d24ec7
|
|
4
|
+
data.tar.gz: 8b97e49e63f9bedd2a0bca43463b6142588159af08a9ff37417e152954828045
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c4beccf52c903c93c7130008da3802266e09e450a9498bc908357c055ff2907d4ad16d8603d71e56db3ed3eca32afae67090f4b93058fe321533491a38e7d983
|
|
7
|
+
data.tar.gz: 6901ce27821196e81225b2c0bd170255307eba5cd65391338738815fd55a2070d82c317e2d9b08f41765fb76e1a465ac40a8919988abe6c1897d46ad0b8e9145
|
data/AUTHENTICATION.md
CHANGED
|
@@ -1,149 +1,122 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
[
|
|
5
|
-
|
|
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-kms-inventory-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
|
-
|
|
19
|
-
|
|
9
|
+
The following example shows how to set up authentication for a local development
|
|
10
|
+
environment with your user credentials.
|
|
20
11
|
|
|
21
|
-
|
|
22
|
-
|
|
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
|
-
|
|
28
|
-
|
|
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
|
-
|
|
18
|
+
```sh
|
|
19
|
+
gcloud auth application-default login
|
|
31
20
|
```
|
|
32
21
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
The google-cloud-kms-inventory-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
|
-
|
|
51
|
-
|
|
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
|
-
|
|
27
|
+
## Credential Lookup
|
|
56
28
|
|
|
57
|
-
The
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
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-kms-inventory-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
|
-
|
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
-
{::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Credentials}):
|
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
|
68
35
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
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
|
-
|
|
74
|
-
require "google/cloud/kms/inventory/v1"
|
|
75
|
-
|
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
|
42
|
+
### Configuration
|
|
77
43
|
|
|
78
|
-
client
|
|
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
|
-
|
|
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
|
-
|
|
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/kms/inventory/v1"
|
|
88
58
|
|
|
89
59
|
client = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client.new do |config|
|
|
90
|
-
config.credentials = "path/to/
|
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
|
91
61
|
end
|
|
92
62
|
```
|
|
93
63
|
|
|
94
|
-
|
|
64
|
+
To configure a credentials file globally for all clients:
|
|
95
65
|
|
|
96
66
|
```ruby
|
|
97
67
|
require "google/cloud/kms/inventory/v1"
|
|
98
68
|
|
|
99
69
|
::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client.configure do |config|
|
|
100
|
-
config.credentials = "path/to/
|
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
|
101
71
|
end
|
|
102
72
|
|
|
103
73
|
client = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client.new
|
|
104
74
|
```
|
|
105
75
|
|
|
106
|
-
###
|
|
76
|
+
### Environment Variables
|
|
107
77
|
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
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
|
-
|
|
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
|
-
|
|
115
|
-
|
|
116
|
-
|
|
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-kms-inventory-v1
|
|
93
|
+
checks for credentials are:
|
|
117
94
|
|
|
118
|
-
|
|
119
|
-
*
|
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
120
97
|
|
|
121
|
-
|
|
98
|
+
```ruby
|
|
99
|
+
require "google/cloud/kms/inventory/v1"
|
|
122
100
|
|
|
123
|
-
|
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
|
125
|
-
connect to most services with google-cloud-kms-inventory-v1.
|
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
|
126
102
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
need a Google Developers service account.
|
|
103
|
+
client = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client.new
|
|
104
|
+
```
|
|
130
105
|
|
|
131
|
-
|
|
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
|
-
|
|
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
|
-
|
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
|
139
113
|
|
|
140
|
-
|
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
|
114
|
+
### Google Cloud Platform environments
|
|
142
115
|
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
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
|
-
|
|
149
|
-
|
|
121
|
+
For more information, see
|
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
|
@@ -31,6 +31,9 @@ module Google
|
|
|
31
31
|
# Provides a cross-region view of all Cloud KMS keys in a given Cloud project.
|
|
32
32
|
#
|
|
33
33
|
class Client
|
|
34
|
+
# @private
|
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "kmsinventory.$UNIVERSE_DOMAIN$"
|
|
36
|
+
|
|
34
37
|
include Paths
|
|
35
38
|
|
|
36
39
|
# @private
|
|
@@ -93,6 +96,15 @@ module Google
|
|
|
93
96
|
@config
|
|
94
97
|
end
|
|
95
98
|
|
|
99
|
+
##
|
|
100
|
+
# The effective universe domain
|
|
101
|
+
#
|
|
102
|
+
# @return [String]
|
|
103
|
+
#
|
|
104
|
+
def universe_domain
|
|
105
|
+
@key_dashboard_service_stub.universe_domain
|
|
106
|
+
end
|
|
107
|
+
|
|
96
108
|
##
|
|
97
109
|
# Create a new KeyDashboardService client object.
|
|
98
110
|
#
|
|
@@ -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
|
|
130
|
-
|
|
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)
|
|
@@ -138,8 +151,10 @@ module Google
|
|
|
138
151
|
|
|
139
152
|
@key_dashboard_service_stub = ::Gapic::ServiceStub.new(
|
|
140
153
|
::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Stub,
|
|
141
|
-
credentials:
|
|
142
|
-
endpoint:
|
|
154
|
+
credentials: credentials,
|
|
155
|
+
endpoint: @config.endpoint,
|
|
156
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
157
|
+
universe_domain: @config.universe_domain,
|
|
143
158
|
channel_args: @config.channel_args,
|
|
144
159
|
interceptors: @config.interceptors,
|
|
145
160
|
channel_pool_config: @config.channel_pool
|
|
@@ -278,9 +293,9 @@ module Google
|
|
|
278
293
|
# end
|
|
279
294
|
#
|
|
280
295
|
# @!attribute [rw] endpoint
|
|
281
|
-
#
|
|
282
|
-
#
|
|
283
|
-
# @return [::String]
|
|
296
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
297
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
298
|
+
# @return [::String,nil]
|
|
284
299
|
# @!attribute [rw] credentials
|
|
285
300
|
# Credentials to send with calls. You may provide any of the following types:
|
|
286
301
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -326,13 +341,20 @@ module Google
|
|
|
326
341
|
# @!attribute [rw] quota_project
|
|
327
342
|
# A separate project against which to charge quota.
|
|
328
343
|
# @return [::String]
|
|
344
|
+
# @!attribute [rw] universe_domain
|
|
345
|
+
# The universe domain within which to make requests. This determines the
|
|
346
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
347
|
+
# universe (usually the default "googleapis.com" universe).
|
|
348
|
+
# @return [::String,nil]
|
|
329
349
|
#
|
|
330
350
|
class Configuration
|
|
331
351
|
extend ::Gapic::Config
|
|
332
352
|
|
|
353
|
+
# @private
|
|
354
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
333
355
|
DEFAULT_ENDPOINT = "kmsinventory.googleapis.com"
|
|
334
356
|
|
|
335
|
-
config_attr :endpoint,
|
|
357
|
+
config_attr :endpoint, nil, ::String, nil
|
|
336
358
|
config_attr :credentials, nil do |value|
|
|
337
359
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
338
360
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -347,6 +369,7 @@ module Google
|
|
|
347
369
|
config_attr :metadata, nil, ::Hash, nil
|
|
348
370
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
349
371
|
config_attr :quota_project, nil, ::String, nil
|
|
372
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
350
373
|
|
|
351
374
|
# @private
|
|
352
375
|
def initialize parent_config = nil
|
|
@@ -33,6 +33,9 @@ module Google
|
|
|
33
33
|
# Provides a cross-region view of all Cloud KMS keys in a given Cloud project.
|
|
34
34
|
#
|
|
35
35
|
class Client
|
|
36
|
+
# @private
|
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "kmsinventory.$UNIVERSE_DOMAIN$"
|
|
38
|
+
|
|
36
39
|
include Paths
|
|
37
40
|
|
|
38
41
|
# @private
|
|
@@ -95,6 +98,15 @@ module Google
|
|
|
95
98
|
@config
|
|
96
99
|
end
|
|
97
100
|
|
|
101
|
+
##
|
|
102
|
+
# The effective universe domain
|
|
103
|
+
#
|
|
104
|
+
# @return [String]
|
|
105
|
+
#
|
|
106
|
+
def universe_domain
|
|
107
|
+
@key_dashboard_service_stub.universe_domain
|
|
108
|
+
end
|
|
109
|
+
|
|
98
110
|
##
|
|
99
111
|
# Create a new KeyDashboardService REST client object.
|
|
100
112
|
#
|
|
@@ -122,8 +134,9 @@ module Google
|
|
|
122
134
|
credentials = @config.credentials
|
|
123
135
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
124
136
|
# but only if the default endpoint does not have a region prefix.
|
|
125
|
-
enable_self_signed_jwt = @config.endpoint
|
|
126
|
-
|
|
137
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
138
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
139
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
127
140
|
credentials ||= Credentials.default scope: @config.scope,
|
|
128
141
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
129
142
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -133,7 +146,12 @@ module Google
|
|
|
133
146
|
@quota_project_id = @config.quota_project
|
|
134
147
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
135
148
|
|
|
136
|
-
@key_dashboard_service_stub = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Rest::ServiceStub.new
|
|
149
|
+
@key_dashboard_service_stub = ::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Rest::ServiceStub.new(
|
|
150
|
+
endpoint: @config.endpoint,
|
|
151
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
152
|
+
universe_domain: @config.universe_domain,
|
|
153
|
+
credentials: credentials
|
|
154
|
+
)
|
|
137
155
|
end
|
|
138
156
|
|
|
139
157
|
# Service calls
|
|
@@ -261,9 +279,9 @@ module Google
|
|
|
261
279
|
# end
|
|
262
280
|
#
|
|
263
281
|
# @!attribute [rw] endpoint
|
|
264
|
-
#
|
|
265
|
-
#
|
|
266
|
-
# @return [::String]
|
|
282
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
283
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
284
|
+
# @return [::String,nil]
|
|
267
285
|
# @!attribute [rw] credentials
|
|
268
286
|
# Credentials to send with calls. You may provide any of the following types:
|
|
269
287
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -300,13 +318,20 @@ module Google
|
|
|
300
318
|
# @!attribute [rw] quota_project
|
|
301
319
|
# A separate project against which to charge quota.
|
|
302
320
|
# @return [::String]
|
|
321
|
+
# @!attribute [rw] universe_domain
|
|
322
|
+
# The universe domain within which to make requests. This determines the
|
|
323
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
324
|
+
# universe (usually the default "googleapis.com" universe).
|
|
325
|
+
# @return [::String,nil]
|
|
303
326
|
#
|
|
304
327
|
class Configuration
|
|
305
328
|
extend ::Gapic::Config
|
|
306
329
|
|
|
330
|
+
# @private
|
|
331
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
307
332
|
DEFAULT_ENDPOINT = "kmsinventory.googleapis.com"
|
|
308
333
|
|
|
309
|
-
config_attr :endpoint,
|
|
334
|
+
config_attr :endpoint, nil, ::String, nil
|
|
310
335
|
config_attr :credentials, nil do |value|
|
|
311
336
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
312
337
|
allowed.any? { |klass| klass === value }
|
|
@@ -318,6 +343,7 @@ module Google
|
|
|
318
343
|
config_attr :metadata, nil, ::Hash, nil
|
|
319
344
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
320
345
|
config_attr :quota_project, nil, ::String, nil
|
|
346
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
321
347
|
|
|
322
348
|
# @private
|
|
323
349
|
def initialize parent_config = nil
|
|
@@ -31,16 +31,28 @@ module Google
|
|
|
31
31
|
# including transcoding, making the REST call, and deserialing the response.
|
|
32
32
|
#
|
|
33
33
|
class ServiceStub
|
|
34
|
-
def initialize endpoint:, credentials:
|
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
35
35
|
# These require statements are intentionally placed here to initialize
|
|
36
36
|
# the REST modules only when it's required.
|
|
37
37
|
require "gapic/rest"
|
|
38
38
|
|
|
39
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
40
|
+
endpoint_template: endpoint_template,
|
|
41
|
+
universe_domain: universe_domain,
|
|
42
|
+
credentials: credentials,
|
|
40
43
|
numeric_enums: true,
|
|
41
44
|
raise_faraday_errors: false
|
|
42
45
|
end
|
|
43
46
|
|
|
47
|
+
##
|
|
48
|
+
# The effective universe domain
|
|
49
|
+
#
|
|
50
|
+
# @return [String]
|
|
51
|
+
#
|
|
52
|
+
def universe_domain
|
|
53
|
+
@client_stub.universe_domain
|
|
54
|
+
end
|
|
55
|
+
|
|
44
56
|
##
|
|
45
57
|
# Baseline implementation for the list_crypto_keys REST call
|
|
46
58
|
#
|
|
@@ -32,6 +32,9 @@ module Google
|
|
|
32
32
|
# given Cloud KMS key via CMEK.
|
|
33
33
|
#
|
|
34
34
|
class Client
|
|
35
|
+
# @private
|
|
36
|
+
DEFAULT_ENDPOINT_TEMPLATE = "kmsinventory.$UNIVERSE_DOMAIN$"
|
|
37
|
+
|
|
35
38
|
include Paths
|
|
36
39
|
|
|
37
40
|
# @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
|
+
@key_tracking_service_stub.universe_domain
|
|
109
|
+
end
|
|
110
|
+
|
|
99
111
|
##
|
|
100
112
|
# Create a new KeyTrackingService client object.
|
|
101
113
|
#
|
|
@@ -129,8 +141,9 @@ module Google
|
|
|
129
141
|
credentials = @config.credentials
|
|
130
142
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
131
143
|
# but only if the default endpoint does not have a region prefix.
|
|
132
|
-
enable_self_signed_jwt = @config.endpoint
|
|
133
|
-
|
|
144
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
145
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
146
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
134
147
|
credentials ||= Credentials.default scope: @config.scope,
|
|
135
148
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
136
149
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -141,8 +154,10 @@ module Google
|
|
|
141
154
|
|
|
142
155
|
@key_tracking_service_stub = ::Gapic::ServiceStub.new(
|
|
143
156
|
::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Stub,
|
|
144
|
-
credentials:
|
|
145
|
-
endpoint:
|
|
157
|
+
credentials: credentials,
|
|
158
|
+
endpoint: @config.endpoint,
|
|
159
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
160
|
+
universe_domain: @config.universe_domain,
|
|
146
161
|
channel_args: @config.channel_args,
|
|
147
162
|
interceptors: @config.interceptors,
|
|
148
163
|
channel_pool_config: @config.channel_pool
|
|
@@ -394,9 +409,9 @@ module Google
|
|
|
394
409
|
# end
|
|
395
410
|
#
|
|
396
411
|
# @!attribute [rw] endpoint
|
|
397
|
-
#
|
|
398
|
-
#
|
|
399
|
-
# @return [::String]
|
|
412
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
413
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
414
|
+
# @return [::String,nil]
|
|
400
415
|
# @!attribute [rw] credentials
|
|
401
416
|
# Credentials to send with calls. You may provide any of the following types:
|
|
402
417
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -442,13 +457,20 @@ module Google
|
|
|
442
457
|
# @!attribute [rw] quota_project
|
|
443
458
|
# A separate project against which to charge quota.
|
|
444
459
|
# @return [::String]
|
|
460
|
+
# @!attribute [rw] universe_domain
|
|
461
|
+
# The universe domain within which to make requests. This determines the
|
|
462
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
463
|
+
# universe (usually the default "googleapis.com" universe).
|
|
464
|
+
# @return [::String,nil]
|
|
445
465
|
#
|
|
446
466
|
class Configuration
|
|
447
467
|
extend ::Gapic::Config
|
|
448
468
|
|
|
469
|
+
# @private
|
|
470
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
449
471
|
DEFAULT_ENDPOINT = "kmsinventory.googleapis.com"
|
|
450
472
|
|
|
451
|
-
config_attr :endpoint,
|
|
473
|
+
config_attr :endpoint, nil, ::String, nil
|
|
452
474
|
config_attr :credentials, nil do |value|
|
|
453
475
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
454
476
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
|
@@ -463,6 +485,7 @@ module Google
|
|
|
463
485
|
config_attr :metadata, nil, ::Hash, nil
|
|
464
486
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
465
487
|
config_attr :quota_project, nil, ::String, nil
|
|
488
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
466
489
|
|
|
467
490
|
# @private
|
|
468
491
|
def initialize parent_config = nil
|
|
@@ -34,6 +34,9 @@ module Google
|
|
|
34
34
|
# given Cloud KMS key via CMEK.
|
|
35
35
|
#
|
|
36
36
|
class Client
|
|
37
|
+
# @private
|
|
38
|
+
DEFAULT_ENDPOINT_TEMPLATE = "kmsinventory.$UNIVERSE_DOMAIN$"
|
|
39
|
+
|
|
37
40
|
include Paths
|
|
38
41
|
|
|
39
42
|
# @private
|
|
@@ -98,6 +101,15 @@ module Google
|
|
|
98
101
|
@config
|
|
99
102
|
end
|
|
100
103
|
|
|
104
|
+
##
|
|
105
|
+
# The effective universe domain
|
|
106
|
+
#
|
|
107
|
+
# @return [String]
|
|
108
|
+
#
|
|
109
|
+
def universe_domain
|
|
110
|
+
@key_tracking_service_stub.universe_domain
|
|
111
|
+
end
|
|
112
|
+
|
|
101
113
|
##
|
|
102
114
|
# Create a new KeyTrackingService REST client object.
|
|
103
115
|
#
|
|
@@ -125,8 +137,9 @@ module Google
|
|
|
125
137
|
credentials = @config.credentials
|
|
126
138
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
|
127
139
|
# but only if the default endpoint does not have a region prefix.
|
|
128
|
-
enable_self_signed_jwt = @config.endpoint
|
|
129
|
-
|
|
140
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
|
141
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
|
142
|
+
!@config.endpoint.split(".").first.include?("-"))
|
|
130
143
|
credentials ||= Credentials.default scope: @config.scope,
|
|
131
144
|
enable_self_signed_jwt: enable_self_signed_jwt
|
|
132
145
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
@@ -136,7 +149,12 @@ module Google
|
|
|
136
149
|
@quota_project_id = @config.quota_project
|
|
137
150
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
|
138
151
|
|
|
139
|
-
@key_tracking_service_stub = ::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Rest::ServiceStub.new
|
|
152
|
+
@key_tracking_service_stub = ::Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Rest::ServiceStub.new(
|
|
153
|
+
endpoint: @config.endpoint,
|
|
154
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
|
155
|
+
universe_domain: @config.universe_domain,
|
|
156
|
+
credentials: credentials
|
|
157
|
+
)
|
|
140
158
|
end
|
|
141
159
|
|
|
142
160
|
# Service calls
|
|
@@ -370,9 +388,9 @@ module Google
|
|
|
370
388
|
# end
|
|
371
389
|
#
|
|
372
390
|
# @!attribute [rw] endpoint
|
|
373
|
-
#
|
|
374
|
-
#
|
|
375
|
-
# @return [::String]
|
|
391
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
|
392
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
|
393
|
+
# @return [::String,nil]
|
|
376
394
|
# @!attribute [rw] credentials
|
|
377
395
|
# Credentials to send with calls. You may provide any of the following types:
|
|
378
396
|
# * (`String`) The path to a service account key file in JSON format
|
|
@@ -409,13 +427,20 @@ module Google
|
|
|
409
427
|
# @!attribute [rw] quota_project
|
|
410
428
|
# A separate project against which to charge quota.
|
|
411
429
|
# @return [::String]
|
|
430
|
+
# @!attribute [rw] universe_domain
|
|
431
|
+
# The universe domain within which to make requests. This determines the
|
|
432
|
+
# default endpoint URL. The default value of nil uses the environment
|
|
433
|
+
# universe (usually the default "googleapis.com" universe).
|
|
434
|
+
# @return [::String,nil]
|
|
412
435
|
#
|
|
413
436
|
class Configuration
|
|
414
437
|
extend ::Gapic::Config
|
|
415
438
|
|
|
439
|
+
# @private
|
|
440
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
|
416
441
|
DEFAULT_ENDPOINT = "kmsinventory.googleapis.com"
|
|
417
442
|
|
|
418
|
-
config_attr :endpoint,
|
|
443
|
+
config_attr :endpoint, nil, ::String, nil
|
|
419
444
|
config_attr :credentials, nil do |value|
|
|
420
445
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
|
421
446
|
allowed.any? { |klass| klass === value }
|
|
@@ -427,6 +452,7 @@ module Google
|
|
|
427
452
|
config_attr :metadata, nil, ::Hash, nil
|
|
428
453
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
|
429
454
|
config_attr :quota_project, nil, ::String, nil
|
|
455
|
+
config_attr :universe_domain, nil, ::String, nil
|
|
430
456
|
|
|
431
457
|
# @private
|
|
432
458
|
def initialize parent_config = nil
|
|
@@ -31,16 +31,28 @@ module Google
|
|
|
31
31
|
# including transcoding, making the REST call, and deserialing the response.
|
|
32
32
|
#
|
|
33
33
|
class ServiceStub
|
|
34
|
-
def initialize endpoint:, credentials:
|
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
|
35
35
|
# These require statements are intentionally placed here to initialize
|
|
36
36
|
# the REST modules only when it's required.
|
|
37
37
|
require "gapic/rest"
|
|
38
38
|
|
|
39
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
39
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
|
40
|
+
endpoint_template: endpoint_template,
|
|
41
|
+
universe_domain: universe_domain,
|
|
42
|
+
credentials: credentials,
|
|
40
43
|
numeric_enums: true,
|
|
41
44
|
raise_faraday_errors: false
|
|
42
45
|
end
|
|
43
46
|
|
|
47
|
+
##
|
|
48
|
+
# The effective universe domain
|
|
49
|
+
#
|
|
50
|
+
# @return [String]
|
|
51
|
+
#
|
|
52
|
+
def universe_domain
|
|
53
|
+
@client_stub.universe_domain
|
|
54
|
+
end
|
|
55
|
+
|
|
44
56
|
##
|
|
45
57
|
# Baseline implementation for the get_protected_resources_summary REST call
|
|
46
58
|
#
|
|
@@ -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
|
|
@@ -304,6 +305,19 @@ module Google
|
|
|
304
305
|
# seconds: 360 # 6 minutes
|
|
305
306
|
# total_poll_timeout:
|
|
306
307
|
# seconds: 54000 # 90 minutes
|
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
|
309
|
+
# @return [::Array<::String>]
|
|
310
|
+
# List of top-level fields of the request message, that should be
|
|
311
|
+
# automatically populated by the client libraries based on their
|
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
|
313
|
+
#
|
|
314
|
+
# Example of a YAML configuration:
|
|
315
|
+
#
|
|
316
|
+
# publishing:
|
|
317
|
+
# method_settings:
|
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
|
319
|
+
# auto_populated_fields:
|
|
320
|
+
# - request_id
|
|
307
321
|
class MethodSettings
|
|
308
322
|
include ::Google::Protobuf::MessageExts
|
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-kms-inventory-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.8.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:
|
|
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.
|
|
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.
|
|
29
|
+
version: 0.21.1
|
|
30
30
|
- - "<"
|
|
31
31
|
- !ruby/object:Gem::Version
|
|
32
32
|
version: 2.a
|
|
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
241
241
|
- !ruby/object:Gem::Version
|
|
242
242
|
version: '0'
|
|
243
243
|
requirements: []
|
|
244
|
-
rubygems_version: 3.
|
|
244
|
+
rubygems_version: 3.5.3
|
|
245
245
|
signing_key:
|
|
246
246
|
specification_version: 4
|
|
247
247
|
summary: API Client library for the KMS Inventory V1 API
|