google-cloud-kms-inventory 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +11 -0
- data/AUTHENTICATION.md +149 -0
- data/LICENSE.md +201 -0
- data/README.md +104 -0
- data/lib/google/cloud/kms/inventory/version.rb +28 -0
- data/lib/google/cloud/kms/inventory.rb +156 -0
- data/lib/google-cloud-kms-inventory.rb +19 -0
- metadata +196 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 50666ae9aa16fda70a4b57fdde1ab027b9f0ae2ce90a34f6c0b47484faf4d73a
|
4
|
+
data.tar.gz: 8117db77abffc5ccdebe98ec8873f51d36ee2eadb14d0f642936ad18a87a9309
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 99d411317a9c9d23bf9501d1c728b8f6576818e868b2e62179b6ccba5ea6312c4114ed8d957e93f73fa7e9b8fd5b99ca3e52e1ea0480ec8e3b372907e105e2a1
|
7
|
+
data.tar.gz: a886268b094c5fbb29d18a483d8a07fb7f813891178e085486b8e3aceb2758f0230caf71c969726b05d74b9a1fcef0f94bbd8e13ee61ba26662ef0c77f9cca5f
|
data/.yardopts
ADDED
data/AUTHENTICATION.md
ADDED
@@ -0,0 +1,149 @@
|
|
1
|
+
# Authentication
|
2
|
+
|
3
|
+
In general, the google-cloud-kms-inventory 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.
|
15
|
+
|
16
|
+
## Quickstart
|
17
|
+
|
18
|
+
1. [Create a service account and credentials](#creating-a-service-account).
|
19
|
+
2. Set the [environment variable](#environment-variables).
|
20
|
+
|
21
|
+
```sh
|
22
|
+
export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
|
23
|
+
```
|
24
|
+
|
25
|
+
3. Initialize the client.
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require "google/cloud/kms/inventory"
|
29
|
+
|
30
|
+
client = Google::Cloud::Kms::Inventory.key_dashboard_service
|
31
|
+
```
|
32
|
+
|
33
|
+
## Credential Lookup
|
34
|
+
|
35
|
+
The google-cloud-kms-inventory 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
|
49
|
+
|
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.
|
54
|
+
|
55
|
+
### Environment Variables
|
56
|
+
|
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.
|
64
|
+
|
65
|
+
The environment variables that google-cloud-kms-inventory
|
66
|
+
checks for credentials are configured on the service Credentials class (such as
|
67
|
+
`::Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Credentials`):
|
68
|
+
|
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
|
72
|
+
|
73
|
+
```ruby
|
74
|
+
require "google/cloud/kms/inventory"
|
75
|
+
|
76
|
+
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
77
|
+
|
78
|
+
client = Google::Cloud::Kms::Inventory.key_dashboard_service
|
79
|
+
```
|
80
|
+
|
81
|
+
### Configuration
|
82
|
+
|
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:
|
85
|
+
|
86
|
+
```ruby
|
87
|
+
require "google/cloud/kms/inventory"
|
88
|
+
|
89
|
+
client = Google::Cloud::Kms::Inventory.key_dashboard_service do |config|
|
90
|
+
config.credentials = "path/to/keyfile.json"
|
91
|
+
end
|
92
|
+
```
|
93
|
+
|
94
|
+
Or globally for all clients:
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
require "google/cloud/kms/inventory"
|
98
|
+
|
99
|
+
Google::Cloud::Kms::Inventory.configure do |config|
|
100
|
+
config.credentials = "path/to/keyfile.json"
|
101
|
+
end
|
102
|
+
|
103
|
+
client = Google::Cloud::Kms::Inventory.key_dashboard_service
|
104
|
+
```
|
105
|
+
|
106
|
+
### Cloud SDK
|
107
|
+
|
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.
|
111
|
+
|
112
|
+
To configure your system for this, simply:
|
113
|
+
|
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.
|
117
|
+
|
118
|
+
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
119
|
+
*should* only be used during development.
|
120
|
+
|
121
|
+
## Creating a Service Account
|
122
|
+
|
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-kms-inventory.
|
126
|
+
|
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.
|
130
|
+
|
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.
|
135
|
+
|
136
|
+
*Note: You may need to enable billing in order to use these services.*
|
137
|
+
|
138
|
+
4. Select **Credentials** from the side navigation.
|
139
|
+
|
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.
|
142
|
+
|
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**.
|
147
|
+
|
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.
|
data/LICENSE.md
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,104 @@
|
|
1
|
+
# Ruby Client for the KMS Inventory API
|
2
|
+
|
3
|
+
API Client library for the KMS Inventory API
|
4
|
+
|
5
|
+
google-cloud-kms-inventory is the official client library for the KMS Inventory API.
|
6
|
+
|
7
|
+
Actual client classes for the various versions of this API are defined in
|
8
|
+
_versioned_ client gems, with names of the form `google-cloud-kms-inventory-v*`.
|
9
|
+
The gem `google-cloud-kms-inventory` is the main client library that brings the
|
10
|
+
verisoned gems in as dependencies, and provides high-level methods for
|
11
|
+
constructing clients. More information on versioned clients can be found below
|
12
|
+
in the section titled *Which client should I use?*.
|
13
|
+
|
14
|
+
View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-kms-inventory/latest)
|
15
|
+
for this library, google-cloud-kms-inventory, to see the convenience methods for
|
16
|
+
constructing client objects. Reference documentation for the client objects
|
17
|
+
themselves can be found in the client library documentation for the versioned
|
18
|
+
client gems:
|
19
|
+
[google-cloud-kms-inventory-v1](https://googleapis.dev/ruby/google-cloud-kms-inventory-v1/latest).
|
20
|
+
|
21
|
+
See also the [Product Documentation](https://cloud.google.com/kms/docs/)
|
22
|
+
for more usage information.
|
23
|
+
|
24
|
+
## Quick Start
|
25
|
+
|
26
|
+
```
|
27
|
+
$ gem install google-cloud-kms-inventory
|
28
|
+
```
|
29
|
+
|
30
|
+
In order to use this library, you first need to go through the following steps:
|
31
|
+
|
32
|
+
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
33
|
+
1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
34
|
+
1. [Enable the API.](https://console.cloud.google.com/apis/library/kmsinventory.googleapis.com)
|
35
|
+
1. {file:AUTHENTICATION.md Set up authentication.}
|
36
|
+
|
37
|
+
## Supported Ruby Versions
|
38
|
+
|
39
|
+
This library is supported on Ruby 2.6+.
|
40
|
+
|
41
|
+
Google provides official support for Ruby versions that are actively supported
|
42
|
+
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
43
|
+
in security maintenance, and not end of life. Older versions of Ruby _may_
|
44
|
+
still work, but are unsupported and not recommended. See
|
45
|
+
https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
|
46
|
+
support schedule.
|
47
|
+
|
48
|
+
## Which client should I use?
|
49
|
+
|
50
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
51
|
+
client library with a name such as `google-cloud-kms-inventory`,
|
52
|
+
and lower-level _versioned_ client libraries with names such as
|
53
|
+
`google-cloud-kms-inventory-v1`.
|
54
|
+
_In most cases, you should install the main client._
|
55
|
+
|
56
|
+
### What's the difference between the main client and a versioned client?
|
57
|
+
|
58
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
59
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
60
|
+
versions, there might be a separate versioned client for each service version.)
|
61
|
+
Most versioned clients are written and maintained by a code generator.
|
62
|
+
|
63
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
64
|
+
interfaces for the service. There will be only one main client for any given
|
65
|
+
service, even a service with multiple versions. The main client includes
|
66
|
+
factory methods for constructing the client objects we recommend for most
|
67
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
68
|
+
client; in other cases, they will be handwritten higher-level client objects
|
69
|
+
with additional capabilities, convenience methods, or best practices built in.
|
70
|
+
Generally, the main client will default to a recommended service version,
|
71
|
+
although in some cases you can override this if you need to talk to a specific
|
72
|
+
service version.
|
73
|
+
|
74
|
+
### Why would I want to use the main client?
|
75
|
+
|
76
|
+
We recommend that most users install the main client gem for a service. You can
|
77
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
78
|
+
`google-cloud-kms-inventory`.
|
79
|
+
The main client is recommended because it will embody the best practices for
|
80
|
+
accessing the service, and may also provide more convenient interfaces or
|
81
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
82
|
+
documentation and samples published by Google will generally demonstrate use of
|
83
|
+
the main client.
|
84
|
+
|
85
|
+
### Why would I want to use a versioned client?
|
86
|
+
|
87
|
+
You can use a versioned client if you are content with a possibly lower-level
|
88
|
+
class interface, you explicitly want to avoid features provided by the main
|
89
|
+
client, or you want to access a specific service version not be covered by the
|
90
|
+
main client. You can identify versioned client gems because the service version
|
91
|
+
is part of the name, e.g. `google-cloud-kms-inventory-v1`.
|
92
|
+
|
93
|
+
### What about the google-apis-<name> clients?
|
94
|
+
|
95
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
96
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
97
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
98
|
+
not offer the same performance, features, and ease of use provided by more
|
99
|
+
modern clients.
|
100
|
+
|
101
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
102
|
+
might need to use one if there is no modern client available for the service.
|
103
|
+
However, if a modern client is available, we generally recommend it over the
|
104
|
+
older `google-apis-` clients.
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Kms
|
23
|
+
module Inventory
|
24
|
+
VERSION = "0.1.0"
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,156 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
# Require this file early so that the version constant gets defined before
|
20
|
+
# requiring "google/cloud". This is because google-cloud-core will load the
|
21
|
+
# entrypoint (gem name) file, which in turn re-requires this file (hence
|
22
|
+
# causing a require cycle) unless the version constant is already defined.
|
23
|
+
require "google/cloud/kms/inventory/version"
|
24
|
+
|
25
|
+
require "googleauth"
|
26
|
+
gem "google-cloud-core"
|
27
|
+
require "google/cloud" unless defined? ::Google::Cloud.new
|
28
|
+
require "google/cloud/config"
|
29
|
+
|
30
|
+
# Set the default configuration
|
31
|
+
::Google::Cloud.configure.add_config! :kms_inventory do |config|
|
32
|
+
config.add_field! :endpoint, "kmsinventory.googleapis.com", match: ::String
|
33
|
+
config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
|
34
|
+
config.add_field! :scope, nil, match: [::Array, ::String]
|
35
|
+
config.add_field! :lib_name, nil, match: ::String
|
36
|
+
config.add_field! :lib_version, nil, match: ::String
|
37
|
+
config.add_field! :interceptors, nil, match: ::Array
|
38
|
+
config.add_field! :timeout, nil, match: ::Numeric
|
39
|
+
config.add_field! :metadata, nil, match: ::Hash
|
40
|
+
config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
|
41
|
+
config.add_field! :quota_project, nil, match: ::String
|
42
|
+
end
|
43
|
+
|
44
|
+
module Google
|
45
|
+
module Cloud
|
46
|
+
module Kms
|
47
|
+
module Inventory
|
48
|
+
##
|
49
|
+
# Create a new client object for KeyDashboardService.
|
50
|
+
#
|
51
|
+
# By default, this returns an instance of
|
52
|
+
# [Google::Cloud::Kms::Inventory::V1::KeyDashboardService::Client](https://googleapis.dev/ruby/google-cloud-kms-inventory-v1/latest/Google/Cloud/Kms/Inventory/V1/KeyDashboardService/Client.html)
|
53
|
+
# for a gRPC client for version V1 of the API.
|
54
|
+
# However, you can specify a different API version by passing it in the
|
55
|
+
# `version` parameter. If the KeyDashboardService service is
|
56
|
+
# supported by that API version, and the corresponding gem is available, the
|
57
|
+
# appropriate versioned client will be returned.
|
58
|
+
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
59
|
+
# the `transport` parameter.
|
60
|
+
#
|
61
|
+
# ## About KeyDashboardService
|
62
|
+
#
|
63
|
+
# Provides a cross-region view of all Cloud KMS keys in a given Cloud project.
|
64
|
+
#
|
65
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
66
|
+
# Defaults to `:v1`.
|
67
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
68
|
+
# @return [::Object] A client object for the specified version.
|
69
|
+
#
|
70
|
+
def self.key_dashboard_service version: :v1, transport: :grpc, &block
|
71
|
+
require "google/cloud/kms/inventory/#{version.to_s.downcase}"
|
72
|
+
|
73
|
+
package_name = Google::Cloud::Kms::Inventory
|
74
|
+
.constants
|
75
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
76
|
+
.first
|
77
|
+
service_module = Google::Cloud::Kms::Inventory.const_get(package_name).const_get(:KeyDashboardService)
|
78
|
+
service_module = service_module.const_get(:Rest) if transport == :rest
|
79
|
+
service_module.const_get(:Client).new(&block)
|
80
|
+
end
|
81
|
+
|
82
|
+
##
|
83
|
+
# Create a new client object for KeyTrackingService.
|
84
|
+
#
|
85
|
+
# By default, this returns an instance of
|
86
|
+
# [Google::Cloud::Kms::Inventory::V1::KeyTrackingService::Client](https://googleapis.dev/ruby/google-cloud-kms-inventory-v1/latest/Google/Cloud/Kms/Inventory/V1/KeyTrackingService/Client.html)
|
87
|
+
# for a gRPC client for version V1 of the API.
|
88
|
+
# However, you can specify a different API version by passing it in the
|
89
|
+
# `version` parameter. If the KeyTrackingService service is
|
90
|
+
# supported by that API version, and the corresponding gem is available, the
|
91
|
+
# appropriate versioned client will be returned.
|
92
|
+
# You can also specify a different transport by passing `:rest` or `:grpc` in
|
93
|
+
# the `transport` parameter.
|
94
|
+
#
|
95
|
+
# ## About KeyTrackingService
|
96
|
+
#
|
97
|
+
# Returns information about the resources in an org that are protected by a
|
98
|
+
# given Cloud KMS key via CMEK.
|
99
|
+
#
|
100
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
101
|
+
# Defaults to `:v1`.
|
102
|
+
# @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
|
103
|
+
# @return [::Object] A client object for the specified version.
|
104
|
+
#
|
105
|
+
def self.key_tracking_service version: :v1, transport: :grpc, &block
|
106
|
+
require "google/cloud/kms/inventory/#{version.to_s.downcase}"
|
107
|
+
|
108
|
+
package_name = Google::Cloud::Kms::Inventory
|
109
|
+
.constants
|
110
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
111
|
+
.first
|
112
|
+
service_module = Google::Cloud::Kms::Inventory.const_get(package_name).const_get(:KeyTrackingService)
|
113
|
+
service_module = service_module.const_get(:Rest) if transport == :rest
|
114
|
+
service_module.const_get(:Client).new(&block)
|
115
|
+
end
|
116
|
+
|
117
|
+
##
|
118
|
+
# Configure the google-cloud-kms-inventory library.
|
119
|
+
#
|
120
|
+
# The following configuration parameters are supported:
|
121
|
+
#
|
122
|
+
# * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
|
123
|
+
# The path to the keyfile as a String, the contents of the keyfile as a
|
124
|
+
# Hash, or a Google::Auth::Credentials object.
|
125
|
+
# * `lib_name` (*type:* `String`) -
|
126
|
+
# The library name as recorded in instrumentation and logging.
|
127
|
+
# * `lib_version` (*type:* `String`) -
|
128
|
+
# The library version as recorded in instrumentation and logging.
|
129
|
+
# * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
|
130
|
+
# An array of interceptors that are run before calls are executed.
|
131
|
+
# * `timeout` (*type:* `Numeric`) -
|
132
|
+
# Default timeout in seconds.
|
133
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) -
|
134
|
+
# Additional headers to be sent with the call.
|
135
|
+
# * `retry_policy` (*type:* `Hash`) -
|
136
|
+
# The retry policy. The value is a hash with the following keys:
|
137
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
138
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
139
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
140
|
+
# * `:retry_codes` (*type:* `Array<String>`) -
|
141
|
+
# The error codes that should trigger a retry.
|
142
|
+
#
|
143
|
+
# @return [::Google::Cloud::Config] The default configuration used by this library
|
144
|
+
#
|
145
|
+
def self.configure
|
146
|
+
yield ::Google::Cloud.configure.kms_inventory if block_given?
|
147
|
+
|
148
|
+
::Google::Cloud.configure.kms_inventory
|
149
|
+
end
|
150
|
+
end
|
151
|
+
end
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
helper_path = ::File.join __dir__, "inventory", "helpers.rb"
|
156
|
+
require "google/cloud/kms/inventory/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "google/cloud/kms/inventory" unless defined? Google::Cloud::Kms::Inventory::VERSION
|
metadata
ADDED
@@ -0,0 +1,196 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-cloud-kms-inventory
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2023-03-09 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: google-cloud-core
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.6'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.6'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: google-cloud-kms-inventory-v1
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0.0'
|
34
|
+
- - "<"
|
35
|
+
- !ruby/object:Gem::Version
|
36
|
+
version: 2.a
|
37
|
+
type: :runtime
|
38
|
+
prerelease: false
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
40
|
+
requirements:
|
41
|
+
- - ">="
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
version: '0.0'
|
44
|
+
- - "<"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: 2.a
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: google-style
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - "~>"
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: 1.26.1
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - "~>"
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: 1.26.1
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: minitest
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - "~>"
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '5.16'
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - "~>"
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '5.16'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: minitest-focus
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '1.1'
|
82
|
+
type: :development
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '1.1'
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: minitest-rg
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - "~>"
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '5.2'
|
96
|
+
type: :development
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '5.2'
|
103
|
+
- !ruby/object:Gem::Dependency
|
104
|
+
name: rake
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '13.0'
|
110
|
+
type: :development
|
111
|
+
prerelease: false
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - ">="
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '13.0'
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: redcarpet
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - "~>"
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '3.0'
|
124
|
+
type: :development
|
125
|
+
prerelease: false
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
127
|
+
requirements:
|
128
|
+
- - "~>"
|
129
|
+
- !ruby/object:Gem::Version
|
130
|
+
version: '3.0'
|
131
|
+
- !ruby/object:Gem::Dependency
|
132
|
+
name: simplecov
|
133
|
+
requirement: !ruby/object:Gem::Requirement
|
134
|
+
requirements:
|
135
|
+
- - "~>"
|
136
|
+
- !ruby/object:Gem::Version
|
137
|
+
version: '0.9'
|
138
|
+
type: :development
|
139
|
+
prerelease: false
|
140
|
+
version_requirements: !ruby/object:Gem::Requirement
|
141
|
+
requirements:
|
142
|
+
- - "~>"
|
143
|
+
- !ruby/object:Gem::Version
|
144
|
+
version: '0.9'
|
145
|
+
- !ruby/object:Gem::Dependency
|
146
|
+
name: yard
|
147
|
+
requirement: !ruby/object:Gem::Requirement
|
148
|
+
requirements:
|
149
|
+
- - "~>"
|
150
|
+
- !ruby/object:Gem::Version
|
151
|
+
version: '0.9'
|
152
|
+
type: :development
|
153
|
+
prerelease: false
|
154
|
+
version_requirements: !ruby/object:Gem::Requirement
|
155
|
+
requirements:
|
156
|
+
- - "~>"
|
157
|
+
- !ruby/object:Gem::Version
|
158
|
+
version: '0.9'
|
159
|
+
description: google-cloud-kms-inventory is the official client library for the KMS
|
160
|
+
Inventory API.
|
161
|
+
email: googleapis-packages@google.com
|
162
|
+
executables: []
|
163
|
+
extensions: []
|
164
|
+
extra_rdoc_files: []
|
165
|
+
files:
|
166
|
+
- ".yardopts"
|
167
|
+
- AUTHENTICATION.md
|
168
|
+
- LICENSE.md
|
169
|
+
- README.md
|
170
|
+
- lib/google-cloud-kms-inventory.rb
|
171
|
+
- lib/google/cloud/kms/inventory.rb
|
172
|
+
- lib/google/cloud/kms/inventory/version.rb
|
173
|
+
homepage: https://github.com/googleapis/google-cloud-ruby
|
174
|
+
licenses:
|
175
|
+
- Apache-2.0
|
176
|
+
metadata: {}
|
177
|
+
post_install_message:
|
178
|
+
rdoc_options: []
|
179
|
+
require_paths:
|
180
|
+
- lib
|
181
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
182
|
+
requirements:
|
183
|
+
- - ">="
|
184
|
+
- !ruby/object:Gem::Version
|
185
|
+
version: '2.6'
|
186
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
187
|
+
requirements:
|
188
|
+
- - ">="
|
189
|
+
- !ruby/object:Gem::Version
|
190
|
+
version: '0'
|
191
|
+
requirements: []
|
192
|
+
rubygems_version: 3.4.2
|
193
|
+
signing_key:
|
194
|
+
specification_version: 4
|
195
|
+
summary: API Client library for the KMS Inventory API
|
196
|
+
test_files: []
|