google-cloud-kms 1.5.1 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9f03c9fa470302d031ea26c617d1a195a3de9109a115c467ad76290e81c7cc08
4
- data.tar.gz: b2f9371d3d862d890d653d94b1b2dc09c5ec5f2cd9d505469f4afe211e9c172e
3
+ metadata.gz: b1c306b26e3c0860a85682c161b0f6072593cd2e283f54dfb9f7db367a29c5fb
4
+ data.tar.gz: ffe66f8463fde4037d6e4cc43765e78e4b0329d3b15137106f007effedad0ee5
5
5
  SHA512:
6
- metadata.gz: 41308a1c12ca9e1f5190f1f3a5fa9808dc0ccb69e476becac1d6fcd96f69d84a56356a2ebd89ca227f11b15167782cc07bde1310ee44fab4047d01645441a631
7
- data.tar.gz: a6c245fb6848593a547b318249d826b0499394b909055f82e76cdf1305c6a9824c5f6a7f7275c2212130a91624a6f0cfaf8751530b7c9dd92e275c633fac8d97
6
+ metadata.gz: f7ce211e076946b7f9701d17b96950cd3ec9233ef1e9486d89b941cb3b838c4262b333a62d11f123d0fe7aeea5f5cdbf8ee0823fded940df887d8a0401396869
7
+ data.tar.gz: 6a61f2351247fc1b5d1a1fa7ece75e10a845413503f8518f05e0efe66ad45bef574a18701f1e9ff1721aae69bdeca981c60bf786d39ce838ad0f5016e73a4dce
data/.yardopts CHANGED
@@ -8,4 +8,5 @@
8
8
  -
9
9
  README.md
10
10
  AUTHENTICATION.md
11
- LICENSE
11
+ MIGRATING.md
12
+ LICENSE.md
data/AUTHENTICATION.md CHANGED
@@ -1,16 +1,17 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-kms library uses [Service
4
- Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within [Google
6
- Cloud Platform environments](#google-cloud-platform-environments)
7
- the credentials will be discovered automatically. When running on other
3
+ In general, the google-cloud-kms 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
8
  environments, the Service Account credentials can be specified by providing the
9
- path to the [JSON
10
- keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
11
- the account (or the JSON itself) in [environment
12
- variables](#environment-variables). Additionally, Cloud SDK credentials can also
13
- be discovered automatically, but this is only recommended during development.
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.
14
15
 
15
16
  ## Quickstart
16
17
 
@@ -18,7 +19,7 @@ be discovered automatically, but this is only recommended during development.
18
19
  2. Set the [environment variable](#environment-variables).
19
20
 
20
21
  ```sh
21
- export KMS_CREDENTIALS=/path/to/json`
22
+ export KMS_CREDENTIALS=path/to/keyfile.json
22
23
  ```
23
24
 
24
25
  3. Initialize the client.
@@ -26,23 +27,14 @@ export KMS_CREDENTIALS=/path/to/json`
26
27
  ```ruby
27
28
  require "google/cloud/kms"
28
29
 
29
- client = Google::Cloud::Kms.new
30
+ client = Google::Cloud::Kms.key_management_service
30
31
  ```
31
32
 
32
- ## Project and Credential Lookup
33
+ ## Credential Lookup
33
34
 
34
35
  The google-cloud-kms library aims to make authentication
35
36
  as simple as possible, and provides several mechanisms to configure your system
36
- without providing **Project ID** and **Service Account Credentials** directly in
37
- code.
38
-
39
- **Project ID** is discovered in the following order:
40
-
41
- 1. Specify project ID in method arguments
42
- 2. Specify project ID in configuration
43
- 3. Discover project ID in environment variables
44
- 4. Discover GCP project ID
45
- 5. Discover project ID in credentials JSON
37
+ without requiring **Service Account Credentials** directly in code.
46
38
 
47
39
  **Credentials** are discovered in the following order:
48
40
 
@@ -55,28 +47,24 @@ code.
55
47
 
56
48
  ### Google Cloud Platform environments
57
49
 
58
- When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
59
- Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
60
- (GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
61
- automatically. Code should be written as if already authenticated.
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.
62
54
 
63
55
  ### Environment Variables
64
56
 
65
- The **Project ID** and **Credentials JSON** can be placed in environment
66
- variables instead of declaring them directly in code. Each service has its own
67
- environment variable, allowing for different service accounts to be used for
68
- different services. (See the READMEs for the individual service gems for
69
- details.) The path to the **Credentials JSON** file can be stored in the
70
- environment variable, or the **Credentials JSON** itself can be stored for
71
- environments such as Docker containers where writing files is difficult or not
72
- encouraged.
73
-
74
- The environment variables that google-cloud-kms checks for project ID are:
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.
75
64
 
76
- 1. `KMS_PROJECT`
77
- 2. `GOOGLE_CLOUD_PROJECT`
78
-
79
- The environment variables that google-cloud-kms checks for credentials are configured on {Google::Cloud::Kms::V1::Credentials}:
65
+ The environment variables that google-cloud-kms
66
+ checks for credentials are configured on the service Credentials class (such as
67
+ `::Google::Cloud::Kms::V1::KeyManagementService::Credentials`):
80
68
 
81
69
  1. `KMS_CREDENTIALS` - Path to JSON file, or JSON contents
82
70
  2. `KMS_KEYFILE` - Path to JSON file, or JSON contents
@@ -87,25 +75,34 @@ The environment variables that google-cloud-kms checks for credentials are confi
87
75
  ```ruby
88
76
  require "google/cloud/kms"
89
77
 
90
- ENV["KMS_PROJECT"] = "my-project-id"
91
78
  ENV["KMS_CREDENTIALS"] = "path/to/keyfile.json"
92
79
 
93
- client = Google::Cloud::Kms.new
80
+ client = Google::Cloud::Kms.key_management_service
94
81
  ```
95
82
 
96
83
  ### Configuration
97
84
 
98
- The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
85
+ The **Credentials JSON** can be configured instead of placing them in
86
+ environment variables. Either on an individual client initialization:
87
+
88
+ ```ruby
89
+ require "google/cloud/kms"
90
+
91
+ client = Google::Cloud::Kms.key_management_service do |config|
92
+ config.credentials = "path/to/keyfile.json"
93
+ end
94
+ ```
95
+
96
+ Or configured globally for all clients:
99
97
 
100
98
  ```ruby
101
99
  require "google/cloud/kms"
102
100
 
103
101
  Google::Cloud::Kms.configure do |config|
104
- config.project_id = "my-project-id"
105
102
  config.credentials = "path/to/keyfile.json"
106
103
  end
107
104
 
108
- client = Google::Cloud::Kms.new
105
+ client = Google::Cloud::Kms.key_management_service
109
106
  ```
110
107
 
111
108
  ### Cloud SDK
@@ -134,24 +131,24 @@ To configure your system for this, simply:
134
131
 
135
132
  ## Creating a Service Account
136
133
 
137
- Google Cloud requires a **Project ID** and **Service Account Credentials** to
138
- connect to the APIs. You will use the **Project ID** and **JSON key file** to
134
+ Google Cloud requires **Service Account Credentials** to
135
+ connect to the APIs. You will use the **JSON key file** to
139
136
  connect to most services with google-cloud-kms.
140
137
 
141
- If you are not running this client within [Google Cloud Platform
142
- environments](#google-cloud-platform-environments), you need a Google
143
- Developers service account.
138
+ If you are not running this client within
139
+ [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
+ need a Google Developers service account.
144
141
 
145
142
  1. Visit the [Google Developers Console][dev-console].
146
- 1. Create a new project or click on an existing project.
147
- 1. Activate the slide-out navigation tray and select **API Manager**. From
143
+ 2. Create a new project or click on an existing project.
144
+ 3. Activate the slide-out navigation tray and select **API Manager**. From
148
145
  here, you will enable the APIs that your application requires.
149
146
 
150
147
  ![Enable the APIs that your application requires][enable-apis]
151
148
 
152
149
  *Note: You may need to enable billing in order to use these services.*
153
150
 
154
- 1. Select **Credentials** from the side navigation.
151
+ 4. Select **Credentials** from the side navigation.
155
152
 
156
153
  You should see a screen like one of the following.
157
154
 
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/MIGRATING.md ADDED
@@ -0,0 +1,326 @@
1
+ ## Migrating to google-cloud-kms 2.0
2
+
3
+ The 2.0 release of the google-cloud-kms client is a significant upgrade
4
+ based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
5
+ and includes substantial interface changes. Existing code written for earlier
6
+ versions of this library will likely require updates to use this version.
7
+ This document describes the changes that have been made, and what you need to
8
+ do to update your usage.
9
+
10
+ To summarize:
11
+
12
+ * The library has been broken out into two libraries. The new gem
13
+ `google-cloud-kms-v1` contains the actual client classes for version
14
+ V1 of the KMS service, and the gem `google-cloud-kms` now
15
+ simply provides a convenience wrapper. See
16
+ [Library Structure](#library-structure) for more info.
17
+ * The library uses a new configuration mechanism giving you closer control
18
+ over endpoint address, network timeouts, and retry. See
19
+ [Client Configuration](#client-configuration) for more info. Furthermore,
20
+ when creating a client object, you can customize its configuration in a
21
+ block rather than passing arguments to the constructor. See
22
+ [Creating Clients](#creating-clients) for more info.
23
+ * Previously, IAM methods such as `set_iam_policy` were exposed on the main
24
+ client object. Now they are on a separate IAM client object. See
25
+ [Creating Clients](#creating-clients) for more info.
26
+ * Previously, positional arguments were used to indicate required arguments.
27
+ Now, all method arguments are keyword arguments, with documentation that
28
+ specifies whether they are required or optional. Additionally, you can pass
29
+ a proto request object instead of separate arguments. See
30
+ [Passing Arguments](#passing-arguments) for more info.
31
+ * Previously, some client classes included helper methods for constructing
32
+ resource paths. These methods now take keyword rather than positional
33
+ arguments, and are also available in a separate paths module. See
34
+ [Resource Path Helpers](#resource-path-helpers) for more info.
35
+ * Previously, clients reported RPC errors by raising instances of
36
+ `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
37
+ `Google::Cloud::Error` and its subclasses. See
38
+ [Handling Errors](#handling-errors) for more info.
39
+ * Some classes have moved into different namespaces. See
40
+ [Class Namespaces](#class-namespaces) for more info.
41
+
42
+ ### Library Structure
43
+
44
+ Older 1.x releases of the `google-cloud-kms` gem were all-in-one gems
45
+ that included potentially multiple clients for multiple versions of the
46
+ KMS service. The `Google::Cloud::Kms.new` factory method would
47
+ return you an instance of a `Google::Cloud::Kms::V1::KeyManagementServiceClient`
48
+ object for the V1 version of the service.
49
+
50
+ With the 2.0 release, the `google-cloud-kms` gem still provides factory
51
+ methods for obtaining clients. (The method signatures will have changed. See
52
+ [Creating Clients](#creating-clients) for details.) However, the actual client
53
+ classes have been moved into separate gems, one per service version. Currently,
54
+ KMS has one version, V1. The
55
+ `Google::Cloud::Kms::V1::KeyManagementService::Client` class, along with its
56
+ helpers and data types, is now part of the `google-cloud-kms-v1` gem.
57
+ If an additional version of the KMS service is released, an additional gem
58
+ may be provided for its client classes.
59
+
60
+ For normal usage, you can continue to install the `google-cloud-kms` gem
61
+ (which will bring in the versioned client gems as dependencies) and continue to
62
+ use factory methods to create clients. However, you may alternatively choose to
63
+ install only one of the versioned gems. For example, if you know you will only
64
+ use `V1` of the service, you can install `google-cloud-kms-v1` by
65
+ itself, and construct instances of the
66
+ `Google::Cloud::Kms::V1::KeyManagementService::Client` client class directly.
67
+
68
+ ### Client Configuration
69
+
70
+ In older releases, if you wanted to customize performance parameters or
71
+ low-level behavior of the client (such as credentials, timeouts, or
72
+ instrumentation), you would pass a variety of keyword arguments to the client
73
+ constructor. It was also extremely difficult to customize the default settings.
74
+
75
+ With the 2.0 release, a configuration interface provides control over these
76
+ parameters, including defaults for all instances of a client, and settings for
77
+ each specific client instance. For example, to set default credentials and
78
+ timeout for all KMS V1 clients:
79
+
80
+ ```
81
+ Google::Cloud::Kms::V1::KeyManagementService::Client.configure do |config|
82
+ config.credentials = "/path/to/credentials.json"
83
+ config.timeout = 10.0
84
+ end
85
+ ```
86
+
87
+ Individual RPCs can also be configured independently. For example, to set the
88
+ timeout for the `list_key_rings` call:
89
+
90
+ ```
91
+ Google::Cloud::Kms::V1::KeyManagementService::Client.configure do |config|
92
+ config.rpcs.list_key_rings.timeout = 20.0
93
+ end
94
+ ```
95
+
96
+ Defaults for certain configurations can be set for all KMS versions and
97
+ services globally:
98
+
99
+ ```
100
+ Google::Cloud::Kms.configure do |config|
101
+ config.credentials = "/path/to/credentials.json"
102
+ config.timeout = 10.0
103
+ end
104
+ ```
105
+
106
+ Finally, you can override the configuration for each client instance. See the
107
+ next section on [Creating Clients](#creating-clients) for details.
108
+
109
+ ### Creating Clients
110
+
111
+ In older releases, to create a client object, you would use the
112
+ `Google::Cloud::Kms.new` class method. Keyword arguments were available to
113
+ select a service version and to configure parameters such as credentials and
114
+ timeouts.
115
+
116
+ With the 2.0 release, use the `Google::Cloud::Kms.key_management_service` class
117
+ method to create a client object. You may select a service version using the
118
+ `:version` keyword argument. However, other configuration parameters should be
119
+ set in a configuration block when you create the client.
120
+
121
+ Old:
122
+ ```
123
+ client = Google::Cloud::Kms.new credentials: "/path/to/credentials.json"
124
+ ```
125
+
126
+ New:
127
+ ```
128
+ client = Google::Cloud::Kms.key_management_service do |config|
129
+ config.credentials = "/path/to/credentials.json"
130
+ end
131
+ ```
132
+
133
+ The configuration block is optional. If you do not provide it, or you do not
134
+ set some configuration parameters, then the default configuration is used. See
135
+ [Client Configuration](#client-configuration).
136
+
137
+ Additionally, IAM-related methods such as `set_iam_policy`, `get_iam_policy`,
138
+ and `test_iam_permissions` have been moved to a separate client class, which
139
+ you can construct by calling the `Google::Cloud::Kms.iam_policy` class method.
140
+
141
+ ### Passing Arguments
142
+
143
+ In older releases, required arguments would be passed as positional method
144
+ arguments, while most optional arguments would be passed as keyword arguments.
145
+
146
+ With the 2.0 release, all RPC arguments are passed as keyword arguments,
147
+ regardless of whether they are required or optional. For example:
148
+
149
+ Old:
150
+ ```
151
+ client = Google::Cloud::Kms.new
152
+
153
+ parent = "projects/my-project/locations/my-location"
154
+
155
+ # Parent is a positional argument, while page_size is a keyword argument.
156
+ response = client.list_key_rings parent, page_size: 10
157
+ ```
158
+
159
+ New:
160
+ ```
161
+ client = Google::Cloud::Kms.key_management_service
162
+
163
+ parent = "projects/my-project/locations/my-location"
164
+
165
+ # Parent and page_size are both keyword arguments
166
+ response = client.list_key_rings parent: parent, page_size: 10
167
+ ```
168
+
169
+ In the 2.0 release, it is also possible to pass a request object, either
170
+ as a hash or as a protocol buffer.
171
+
172
+ New:
173
+ ```
174
+ client = Google::Cloud::Kms.key_management_service
175
+
176
+ request = Google::Cloud::Kms::V1::ListKeyRingsRequest.new(
177
+ parent: "projects/my-project/locations/my-location",
178
+ page_size: 10
179
+ )
180
+
181
+ # Pass a request object as a positional argument:
182
+ response = client.list_key_rings request
183
+ ```
184
+
185
+ Finally, in older releases, to provide call options, you would pass a
186
+ `Google::Gax::CallOptions` object with the `:options` keyword argument. In the
187
+ 2.0 release, pass call options using a _second set_ of keyword arguments.
188
+
189
+ Old:
190
+ ```
191
+ client = Google::Cloud::Kms.new
192
+
193
+ parent = "projects/my-project/locations/my-location"
194
+
195
+ options = Google::Gax::CallOptions.new timeout: 10.0
196
+
197
+ response = client.list_key_rings parent, page_size: 10, options: options
198
+ ```
199
+
200
+ New:
201
+ ```
202
+ client = Google::Cloud::Kms.key_management_service
203
+
204
+ parent = "projects/my-project/locations/my-location"
205
+
206
+ # Use a hash to wrap the normal call arguments (or pass a request object), and
207
+ # then add further keyword arguments for the call options.
208
+ response = client.list_key_rings(
209
+ { parent: parent, page_size: 10 },
210
+ timeout: 10.0
211
+ )
212
+ ```
213
+
214
+ ### Resource Path Helpers
215
+
216
+ The client library includes helper methods for generating the resource path
217
+ strings passed to many calls. These helpers have changed in two ways:
218
+
219
+ * In older releases, they are both _class_ methods and _instance_ methods on
220
+ the client class. In the 2.0 release, they are _instance methods only_.
221
+ However, they are also available on a separate paths module that you can
222
+ include elsewhere for convenience.
223
+ * In older releases, arguments to a resource path helper are passed as
224
+ _positional_ arguments. In the 2.0 release, they are passed as named _keyword_
225
+ arguments.
226
+
227
+ Following is an example involving using a resource path helper.
228
+
229
+ Old:
230
+ ```
231
+ client = Google::Cloud::Kms.new
232
+
233
+ # Call the helper on the client instance
234
+ parent = client.location_path "my-project", "my-location"
235
+
236
+ response = client.list_key_rings parent
237
+ ```
238
+
239
+ New:
240
+ ```
241
+ client = Google::Cloud::Kms.key_management_service
242
+
243
+ # Call the helper on the client instance, and use keyword arguments
244
+ parent = client.location_path project: "my-project", location: "my-location"
245
+
246
+ response = client.list_key_rings parent: parent
247
+ ```
248
+
249
+ In the 2.0 client, you can also use the paths module as a convenience module.
250
+
251
+ New:
252
+ ```
253
+ # Bring the path helper methods into the current class
254
+ include Google::Cloud::Kms::V1::KeyManagementService::Paths
255
+
256
+ def foo
257
+ client = Google::Cloud::Kms.key_management_service
258
+
259
+ # Call the included helper method
260
+ parent = location_path project: "my-project", location: "my-location"
261
+
262
+ response = client.list_key_rings parent: parent
263
+
264
+ # Do something with response...
265
+ end
266
+ ```
267
+
268
+ ### Handling Errors
269
+
270
+ The client reports standard
271
+ [gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
272
+ by raising exceptions. In older releases, these exceptions were located in the
273
+ `Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
274
+ exception class, defined in the `google-gax` gem. However, these classes were
275
+ different from the standard exceptions (subclasses of `Google::Cloud::Error`)
276
+ thrown by other client libraries such as `google-cloud-storage`.
277
+
278
+ The 2.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
279
+ for consistency across all the Google Cloud client libraries. In general, these
280
+ exceptions have the same name as their counterparts from older releases, but
281
+ are located in the `Google::Cloud` namespace rather than the `Google::Gax`
282
+ namespace.
283
+
284
+ Old:
285
+ ```
286
+ client = Google::Cloud::Kms.new
287
+
288
+ parent = "projects/my-project/locations/my-location"
289
+
290
+ begin
291
+ response = client.list_key_rings parent, page_size: 10
292
+ rescue Google::Gax::Error => e
293
+ # Handle exceptions that subclass Google::Gax::Error
294
+ end
295
+ ```
296
+
297
+ New:
298
+ ```
299
+ client = Google::Cloud::Kms.key_management_service
300
+
301
+ parent = "projects/my-project/locations/my-location"
302
+
303
+ begin
304
+ response = client.list_key_rings parent: parent, page_size: 10
305
+ rescue Google::Cloud::Error => e
306
+ # Handle exceptions that subclass Google::Cloud::Error
307
+ end
308
+ ```
309
+
310
+ ### Class Namespaces
311
+
312
+ In older releases, the client object was of classes with names like:
313
+ `Google::Cloud::Kms::V1::KeyManagementServiceClient`.
314
+ In the 2.0 release, the client object is of a different class:
315
+ `Google::Cloud::Kms::V1::KeyManagementService::Client`.
316
+ Note that most users will use the factory methods such as
317
+ `Google::Cloud::Kms.key_management_service` to create instances of the client object,
318
+ so you may not need to reference the actual class directly.
319
+ See [Creating Clients](#creating-clients).
320
+
321
+ In older releases, the credentials object was of class
322
+ `Google::Cloud::Kms::V1::Credentials`.
323
+ In the 2.0 release, each service has its own credentials class, e.g.
324
+ `Google::Cloud::Kms::V1::KeyManagementService::Credentials`.
325
+ Again, most users will not need to reference this class directly.
326
+ See [Client Configuration](#client-configuration).