google-cloud-kms 1.5.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f03c9fa470302d031ea26c617d1a195a3de9109a115c467ad76290e81c7cc08
-  data.tar.gz: b2f9371d3d862d890d653d94b1b2dc09c5ec5f2cd9d505469f4afe211e9c172e
+  metadata.gz: b1c306b26e3c0860a85682c161b0f6072593cd2e283f54dfb9f7db367a29c5fb
+  data.tar.gz: ffe66f8463fde4037d6e4cc43765e78e4b0329d3b15137106f007effedad0ee5
 SHA512:
-  metadata.gz: 41308a1c12ca9e1f5190f1f3a5fa9808dc0ccb69e476becac1d6fcd96f69d84a56356a2ebd89ca227f11b15167782cc07bde1310ee44fab4047d01645441a631
-  data.tar.gz: a6c245fb6848593a547b318249d826b0499394b909055f82e76cdf1305c6a9824c5f6a7f7275c2212130a91624a6f0cfaf8751530b7c9dd92e275c633fac8d97
+  metadata.gz: f7ce211e076946b7f9701d17b96950cd3ec9233ef1e9486d89b941cb3b838c4262b333a62d11f123d0fe7aeea5f5cdbf8ee0823fded940df887d8a0401396869
+  data.tar.gz: 6a61f2351247fc1b5d1a1fa7ece75e10a845413503f8518f05e0efe66ad45bef574a18701f1e9ff1721aae69bdeca981c60bf786d39ce838ad0f5016e73a4dce

data/.yardopts

@@ -8,4 +8,5 @@
 -
 README.md
 AUTHENTICATION.md
-LICENSE
+MIGRATING.md
+LICENSE.md

data/AUTHENTICATION.md

@@ -1,16 +1,17 @@
 # Authentication
 
-In general, the google-cloud-kms library uses [Service
-Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
-credentials to connect to Google Cloud services. When running within [Google
-Cloud Platform environments](#google-cloud-platform-environments)
-the credentials will be discovered automatically. When running on other
+In general, the google-cloud-kms library uses
+[Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within
+[Google Cloud Platform environments](#google-cloud-platform-environments) the
+credentials will be discovered automatically. When running on other
 environments, the Service Account credentials can be specified by providing the
-path to the [JSON
-keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
-the account (or the JSON itself) in [environment
-variables](#environment-variables). Additionally, Cloud SDK credentials can also
-be discovered automatically, but this is only recommended during development.
+path to the
+[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
+for the account (or the JSON itself) in
+[environment variables](#environment-variables). Additionally, Cloud SDK
+credentials can also be discovered automatically, but this is only recommended
+during development.
 
 ## Quickstart
 
@@ -18,7 +19,7 @@ be discovered automatically, but this is only recommended during development.
 2. Set the [environment variable](#environment-variables).
 
 ```sh
-export KMS_CREDENTIALS=/path/to/json`
+export KMS_CREDENTIALS=path/to/keyfile.json
 ```
 
 3. Initialize the client.
@@ -26,23 +27,14 @@ export KMS_CREDENTIALS=/path/to/json`
 ```ruby
 require "google/cloud/kms"
 
-client = Google::Cloud::Kms.new
+client = Google::Cloud::Kms.key_management_service
 ```
 
-## Project and Credential Lookup
+## Credential Lookup
 
 The google-cloud-kms library aims to make authentication
 as simple as possible, and provides several mechanisms to configure your system
-without providing **Project ID** and **Service Account Credentials** directly in
-code.
-
-**Project ID** is discovered in the following order:
-
-1. Specify project ID in method arguments
-2. Specify project ID in configuration
-3. Discover project ID in environment variables
-4. Discover GCP project ID
-5. Discover project ID in credentials JSON
+without requiring **Service Account Credentials** directly in code.
 
 **Credentials** are discovered in the following order:
 
@@ -55,28 +47,24 @@ code.
 
 ### Google Cloud Platform environments
 
-When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE),
-Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions
-(GCF) and Cloud Run, the **Project ID** and **Credentials** and are discovered
-automatically. Code should be written as if already authenticated.
+When running on Google Cloud Platform (GCP), including Google Compute Engine
+(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
+Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
+Code should be written as if already authenticated.
 
 ### Environment Variables
 
-The **Project ID** and **Credentials JSON** can be placed in environment
-variables instead of declaring them directly in code. Each service has its own
-environment variable, allowing for different service accounts to be used for
-different services. (See the READMEs for the individual service gems for
-details.) The path to the **Credentials JSON** file can be stored in the
-environment variable, or the **Credentials JSON** itself can be stored for
-environments such as Docker containers where writing files is difficult or not
-encouraged.
-
-The environment variables that google-cloud-kms checks for project ID are:
+The **Credentials JSON** can be placed in environment variables instead of
+declaring them directly in code. Each service has its own environment variable,
+allowing for different service accounts to be used for different services. (See
+the READMEs for the individual service gems for details.) The path to the
+**Credentials JSON** file can be stored in the environment variable, or the
+**Credentials JSON** itself can be stored for environments such as Docker
+containers where writing files is difficult or not encouraged.
 
-1. `KMS_PROJECT`
-2. `GOOGLE_CLOUD_PROJECT`
-
-The environment variables that google-cloud-kms checks for credentials are configured on {Google::Cloud::Kms::V1::Credentials}:
+The environment variables that google-cloud-kms
+checks for credentials are configured on the service Credentials class (such as
+`::Google::Cloud::Kms::V1::KeyManagementService::Credentials`):
 
 1. `KMS_CREDENTIALS` - Path to JSON file, or JSON contents
 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
 ```ruby
 require "google/cloud/kms"
 
-ENV["KMS_PROJECT"]     = "my-project-id"
 ENV["KMS_CREDENTIALS"] = "path/to/keyfile.json"
 
-client = Google::Cloud::Kms.new
+client = Google::Cloud::Kms.key_management_service
 ```
 
 ### Configuration
 
-The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+The **Credentials JSON** can be configured instead of placing them in
+environment variables. Either on an individual client initialization:
+
+```ruby
+require "google/cloud/kms"
+
+client = Google::Cloud::Kms.key_management_service do |config|
+  config.credentials = "path/to/keyfile.json"
+end
+```
+
+Or configured globally for all clients:
 
 ```ruby
 require "google/cloud/kms"
 
 Google::Cloud::Kms.configure do |config|
-  config.project_id  = "my-project-id"
   config.credentials = "path/to/keyfile.json"
 end
 
-client = Google::Cloud::Kms.new
+client = Google::Cloud::Kms.key_management_service
 ```
 
 ### Cloud SDK
@@ -134,24 +131,24 @@ To configure your system for this, simply:
 
 ## Creating a Service Account
 
-Google Cloud requires a **Project ID** and **Service Account Credentials** to
-connect to the APIs. You will use the **Project ID** and **JSON key file** to
+Google Cloud requires **Service Account Credentials** to
+connect to the APIs. You will use the **JSON key file** to
 connect to most services with google-cloud-kms.
 
-If you are not running this client within [Google Cloud Platform
-environments](#google-cloud-platform-environments), you need a Google
-Developers service account.
+If you are not running this client within
+[Google Cloud Platform environments](#google-cloud-platform-environments), you
+need a Google Developers service account.
 
 1. Visit the [Google Developers Console][dev-console].
-1. Create a new project or click on an existing project.
-1. Activate the slide-out navigation tray and select **API Manager**. From
+2. Create a new project or click on an existing project.
+3. Activate the slide-out navigation tray and select **API Manager**. From
    here, you will enable the APIs that your application requires.
 
    ![Enable the APIs that your application requires][enable-apis]
 
    *Note: You may need to enable billing in order to use these services.*
 
-1. Select **Credentials** from the side navigation.
+4. Select **Credentials** from the side navigation.
 
    You should see a screen like one of the following.
 

data/LICENSE.md

@@ -0,0 +1,201 @@
+                                  Apache License
+                            Version 2.0, January 2004
+                         http://www.apache.org/licenses/
+
+    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+    1. Definitions.
+
+       "License" shall mean the terms and conditions for use, reproduction,
+       and distribution as defined by Sections 1 through 9 of this document.
+
+       "Licensor" shall mean the copyright owner or entity authorized by
+       the copyright owner that is granting the License.
+
+       "Legal Entity" shall mean the union of the acting entity and all
+       other entities that control, are controlled by, or are under common
+       control with that entity. For the purposes of this definition,
+       "control" means (i) the power, direct or indirect, to cause the
+       direction or management of such entity, whether by contract or
+       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+       outstanding shares, or (iii) beneficial ownership of such entity.
+
+       "You" (or "Your") shall mean an individual or Legal Entity
+       exercising permissions granted by this License.
+
+       "Source" form shall mean the preferred form for making modifications,
+       including but not limited to software source code, documentation
+       source, and configuration files.
+
+       "Object" form shall mean any form resulting from mechanical
+       transformation or translation of a Source form, including but
+       not limited to compiled object code, generated documentation,
+       and conversions to other media types.
+
+       "Work" shall mean the work of authorship, whether in Source or
+       Object form, made available under the License, as indicated by a
+       copyright notice that is included in or attached to the work
+       (an example is provided in the Appendix below).
+
+       "Derivative Works" shall mean any work, whether in Source or Object
+       form, that is based on (or derived from) the Work and for which the
+       editorial revisions, annotations, elaborations, or other modifications
+       represent, as a whole, an original work of authorship. For the purposes
+       of this License, Derivative Works shall not include works that remain
+       separable from, or merely link (or bind by name) to the interfaces of,
+       the Work and Derivative Works thereof.
+
+       "Contribution" shall mean any work of authorship, including
+       the original version of the Work and any modifications or additions
+       to that Work or Derivative Works thereof, that is intentionally
+       submitted to Licensor for inclusion in the Work by the copyright owner
+       or by an individual or Legal Entity authorized to submit on behalf of
+       the copyright owner. For the purposes of this definition, "submitted"
+       means any form of electronic, verbal, or written communication sent
+       to the Licensor or its representatives, including but not limited to
+       communication on electronic mailing lists, source code control systems,
+       and issue tracking systems that are managed by, or on behalf of, the
+       Licensor for the purpose of discussing and improving the Work, but
+       excluding communication that is conspicuously marked or otherwise
+       designated in writing by the copyright owner as "Not a Contribution."
+
+       "Contributor" shall mean Licensor and any individual or Legal Entity
+       on behalf of whom a Contribution has been received by Licensor and
+       subsequently incorporated within the Work.
+
+    2. Grant of Copyright License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       copyright license to reproduce, prepare Derivative Works of,
+       publicly display, publicly perform, sublicense, and distribute the
+       Work and such Derivative Works in Source or Object form.
+
+    3. Grant of Patent License. Subject to the terms and conditions of
+       this License, each Contributor hereby grants to You a perpetual,
+       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+       (except as stated in this section) patent license to make, have made,
+       use, offer to sell, sell, import, and otherwise transfer the Work,
+       where such license applies only to those patent claims licensable
+       by such Contributor that are necessarily infringed by their
+       Contribution(s) alone or by combination of their Contribution(s)
+       with the Work to which such Contribution(s) was submitted. If You
+       institute patent litigation against any entity (including a
+       cross-claim or counterclaim in a lawsuit) alleging that the Work
+       or a Contribution incorporated within the Work constitutes direct
+       or contributory patent infringement, then any patent licenses
+       granted to You under this License for that Work shall terminate
+       as of the date such litigation is filed.
+
+    4. Redistribution. You may reproduce and distribute copies of the
+       Work or Derivative Works thereof in any medium, with or without
+       modifications, and in Source or Object form, provided that You
+       meet the following conditions:
+
+       (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+       (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+       (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+       (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+       You may add Your own copyright statement to Your modifications and
+       may provide additional or different license terms and conditions
+       for use, reproduction, or distribution of Your modifications, or
+       for any such Derivative Works as a whole, provided Your use,
+       reproduction, and distribution of the Work otherwise complies with
+       the conditions stated in this License.
+
+    5. Submission of Contributions. Unless You explicitly state otherwise,
+       any Contribution intentionally submitted for inclusion in the Work
+       by You to the Licensor shall be under the terms and conditions of
+       this License, without any additional terms or conditions.
+       Notwithstanding the above, nothing herein shall supersede or modify
+       the terms of any separate license agreement you may have executed
+       with Licensor regarding such Contributions.
+
+    6. Trademarks. This License does not grant permission to use the trade
+       names, trademarks, service marks, or product names of the Licensor,
+       except as required for reasonable and customary use in describing the
+       origin of the Work and reproducing the content of the NOTICE file.
+
+    7. Disclaimer of Warranty. Unless required by applicable law or
+       agreed to in writing, Licensor provides the Work (and each
+       Contributor provides its Contributions) on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+       implied, including, without limitation, any warranties or conditions
+       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+       PARTICULAR PURPOSE. You are solely responsible for determining the
+       appropriateness of using or redistributing the Work and assume any
+       risks associated with Your exercise of permissions under this License.
+
+    8. Limitation of Liability. In no event and under no legal theory,
+       whether in tort (including negligence), contract, or otherwise,
+       unless required by applicable law (such as deliberate and grossly
+       negligent acts) or agreed to in writing, shall any Contributor be
+       liable to You for damages, including any direct, indirect, special,
+       incidental, or consequential damages of any character arising as a
+       result of this License or out of the use or inability to use the
+       Work (including but not limited to damages for loss of goodwill,
+       work stoppage, computer failure or malfunction, or any and all
+       other commercial damages or losses), even if such Contributor
+       has been advised of the possibility of such damages.
+
+    9. Accepting Warranty or Additional Liability. While redistributing
+       the Work or Derivative Works thereof, You may choose to offer,
+       and charge a fee for, acceptance of support, warranty, indemnity,
+       or other liability obligations and/or rights consistent with this
+       License. However, in accepting such obligations, You may act only
+       on Your own behalf and on Your sole responsibility, not on behalf
+       of any other Contributor, and only if You agree to indemnify,
+       defend, and hold each Contributor harmless for any liability
+       incurred by, or claims asserted against, such Contributor by reason
+       of your accepting any such warranty or additional liability.
+
+    END OF TERMS AND CONDITIONS
+
+    APPENDIX: How to apply the Apache License to your work.
+
+       To apply the Apache License to your work, attach the following
+       boilerplate notice, with the fields enclosed by brackets "[]"
+       replaced with your own identifying information. (Don't include
+       the brackets!)  The text should be enclosed in the appropriate
+       comment syntax for the file format. We also recommend that a
+       file or class name and description of purpose be included on the
+       same "printed page" as the copyright notice for easier
+       identification within third-party archives.
+
+    Copyright [yyyy] [name of copyright owner]
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/MIGRATING.md

@@ -0,0 +1,326 @@
+## Migrating to google-cloud-kms 2.0
+
+The 2.0 release of the google-cloud-kms client is a significant upgrade
+based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
+and includes substantial interface changes. Existing code written for earlier
+versions of this library will likely require updates to use this version.
+This document describes the changes that have been made, and what you need to
+do to update your usage.
+
+To summarize:
+
+ *  The library has been broken out into two libraries. The new gem
+    `google-cloud-kms-v1` contains the actual client classes for version
+    V1 of the KMS service, and the gem `google-cloud-kms` now
+    simply provides a convenience wrapper. See
+    [Library Structure](#library-structure) for more info.
+ *  The library uses a new configuration mechanism giving you closer control
+    over endpoint address, network timeouts, and retry. See
+    [Client Configuration](#client-configuration) for more info. Furthermore,
+    when creating a client object, you can customize its configuration in a
+    block rather than passing arguments to the constructor. See
+    [Creating Clients](#creating-clients) for more info.
+ *  Previously, IAM methods such as `set_iam_policy` were exposed on the main
+    client object. Now they are on a separate IAM client object. See
+    [Creating Clients](#creating-clients) for more info.
+ *  Previously, positional arguments were used to indicate required arguments.
+    Now, all method arguments are keyword arguments, with documentation that
+    specifies whether they are required or optional. Additionally, you can pass
+    a proto request object instead of separate arguments. See
+    [Passing Arguments](#passing-arguments) for more info.
+ *  Previously, some client classes included helper methods for constructing
+    resource paths. These methods now take keyword rather than positional
+    arguments, and are also available in a separate paths module. See
+    [Resource Path Helpers](#resource-path-helpers) for more info.
+ *  Previously, clients reported RPC errors by raising instances of
+    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
+    `Google::Cloud::Error` and its subclasses. See
+    [Handling Errors](#handling-errors) for more info.
+ *  Some classes have moved into different namespaces. See
+    [Class Namespaces](#class-namespaces) for more info.
+
+### Library Structure
+
+Older 1.x releases of the `google-cloud-kms` gem were all-in-one gems
+that included potentially multiple clients for multiple versions of the
+KMS service. The `Google::Cloud::Kms.new` factory method would
+return you an instance of a `Google::Cloud::Kms::V1::KeyManagementServiceClient`
+object for the V1 version of the service.
+
+With the 2.0 release, the `google-cloud-kms` gem still provides factory
+methods for obtaining clients. (The method signatures will have changed. See
+[Creating Clients](#creating-clients) for details.) However, the actual client
+classes have been moved into separate gems, one per service version. Currently,
+KMS has one version, V1. The
+`Google::Cloud::Kms::V1::KeyManagementService::Client` class, along with its
+helpers and data types, is now part of the `google-cloud-kms-v1` gem.
+If an additional version of the KMS service is released, an additional gem
+may be provided for its client classes.
+
+For normal usage, you can continue to install the `google-cloud-kms` gem
+(which will bring in the versioned client gems as dependencies) and continue to
+use factory methods to create clients. However, you may alternatively choose to
+install only one of the versioned gems. For example, if you know you will only
+use `V1` of the service, you can install `google-cloud-kms-v1` by
+itself, and construct instances of the
+`Google::Cloud::Kms::V1::KeyManagementService::Client` client class directly.
+
+### Client Configuration
+
+In older releases, if you wanted to customize performance parameters or
+low-level behavior of the client (such as credentials, timeouts, or
+instrumentation), you would pass a variety of keyword arguments to the client
+constructor. It was also extremely difficult to customize the default settings.
+
+With the 2.0 release, a configuration interface provides control over these
+parameters, including defaults for all instances of a client, and settings for
+each specific client instance. For example, to set default credentials and
+timeout for all KMS V1 clients:
+
+```
+Google::Cloud::Kms::V1::KeyManagementService::Client.configure do |config|
+  config.credentials = "/path/to/credentials.json"
+  config.timeout = 10.0
+end
+```
+
+Individual RPCs can also be configured independently. For example, to set the
+timeout for the `list_key_rings` call:
+
+```
+Google::Cloud::Kms::V1::KeyManagementService::Client.configure do |config|
+  config.rpcs.list_key_rings.timeout = 20.0
+end
+```
+
+Defaults for certain configurations can be set for all KMS versions and
+services globally:
+
+```
+Google::Cloud::Kms.configure do |config|
+  config.credentials = "/path/to/credentials.json"
+  config.timeout = 10.0
+end
+```
+
+Finally, you can override the configuration for each client instance. See the
+next section on [Creating Clients](#creating-clients) for details.
+
+### Creating Clients
+
+In older releases, to create a client object, you would use the
+`Google::Cloud::Kms.new` class method. Keyword arguments were available to
+select a service version and to configure parameters such as credentials and
+timeouts.
+
+With the 2.0 release, use the `Google::Cloud::Kms.key_management_service` class
+method to create a client object. You may select a service version using the
+`:version` keyword argument. However, other configuration parameters should be
+set in a configuration block when you create the client.
+
+Old:
+```
+client = Google::Cloud::Kms.new credentials: "/path/to/credentials.json"
+```
+
+New:
+```
+client = Google::Cloud::Kms.key_management_service do |config|
+  config.credentials = "/path/to/credentials.json"
+end
+```
+
+The configuration block is optional. If you do not provide it, or you do not
+set some configuration parameters, then the default configuration is used. See
+[Client Configuration](#client-configuration).
+
+Additionally, IAM-related methods such as `set_iam_policy`, `get_iam_policy`,
+and `test_iam_permissions` have been moved to a separate client class, which
+you can construct by calling the `Google::Cloud::Kms.iam_policy` class method.
+
+### Passing Arguments
+
+In older releases, required arguments would be passed as positional method
+arguments, while most optional arguments would be passed as keyword arguments.
+
+With the 2.0 release, all RPC arguments are passed as keyword arguments,
+regardless of whether they are required or optional. For example:
+
+Old:
+```
+client = Google::Cloud::Kms.new
+
+parent = "projects/my-project/locations/my-location"
+
+# Parent is a positional argument, while page_size is a keyword argument.
+response = client.list_key_rings parent, page_size: 10
+```
+
+New:
+```
+client = Google::Cloud::Kms.key_management_service
+
+parent = "projects/my-project/locations/my-location"
+
+# Parent and page_size are both keyword arguments
+response = client.list_key_rings parent: parent, page_size: 10
+```
+
+In the 2.0 release, it is also possible to pass a request object, either
+as a hash or as a protocol buffer.
+
+New:
+```
+client = Google::Cloud::Kms.key_management_service
+
+request = Google::Cloud::Kms::V1::ListKeyRingsRequest.new(
+  parent: "projects/my-project/locations/my-location",
+  page_size: 10
+)
+
+# Pass a request object as a positional argument:
+response = client.list_key_rings request
+```
+
+Finally, in older releases, to provide call options, you would pass a
+`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
+2.0 release, pass call options using a _second set_ of keyword arguments.
+
+Old:
+```
+client = Google::Cloud::Kms.new
+
+parent = "projects/my-project/locations/my-location"
+
+options = Google::Gax::CallOptions.new timeout: 10.0
+
+response = client.list_key_rings parent, page_size: 10, options: options
+```
+
+New:
+```
+client = Google::Cloud::Kms.key_management_service
+
+parent = "projects/my-project/locations/my-location"
+
+# Use a hash to wrap the normal call arguments (or pass a request object), and
+# then add further keyword arguments for the call options.
+response = client.list_key_rings(
+  { parent: parent, page_size: 10 },
+  timeout: 10.0
+)
+```
+
+### Resource Path Helpers
+
+The client library includes helper methods for generating the resource path
+strings passed to many calls. These helpers have changed in two ways:
+
+* In older releases, they are both _class_ methods and _instance_ methods on
+  the client class. In the 2.0 release, they are _instance methods only_.
+  However, they are also available on a separate paths module that you can
+  include elsewhere for convenience.
+* In older releases, arguments to a resource path helper are passed as
+  _positional_ arguments. In the 2.0 release, they are passed as named _keyword_
+  arguments.
+
+Following is an example involving using a resource path helper.
+
+Old:
+```
+client = Google::Cloud::Kms.new
+
+# Call the helper on the client instance
+parent = client.location_path "my-project", "my-location"
+
+response = client.list_key_rings parent
+```
+
+New:
+```
+client = Google::Cloud::Kms.key_management_service
+
+# Call the helper on the client instance, and use keyword arguments
+parent = client.location_path project: "my-project", location: "my-location"
+
+response = client.list_key_rings parent: parent
+```
+
+In the 2.0 client, you can also use the paths module as a convenience module.
+
+New:
+```
+# Bring the path helper methods into the current class
+include Google::Cloud::Kms::V1::KeyManagementService::Paths
+
+def foo
+  client = Google::Cloud::Kms.key_management_service
+
+  # Call the included helper method
+  parent = location_path project: "my-project", location: "my-location"
+
+  response = client.list_key_rings parent: parent
+
+  # Do something with response...
+end
+```
+
+### Handling Errors
+
+The client reports standard
+[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
+by raising exceptions. In older releases, these exceptions were located in the
+`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
+exception class, defined in the `google-gax` gem. However, these classes were
+different from the standard exceptions (subclasses of `Google::Cloud::Error`)
+thrown by other client libraries such as `google-cloud-storage`.
+
+The 2.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
+for consistency across all the Google Cloud client libraries. In general, these
+exceptions have the same name as their counterparts from older releases, but
+are located in the `Google::Cloud` namespace rather than the `Google::Gax`
+namespace.
+
+Old:
+```
+client = Google::Cloud::Kms.new
+
+parent = "projects/my-project/locations/my-location"
+
+begin
+  response = client.list_key_rings parent, page_size: 10
+rescue Google::Gax::Error => e
+  # Handle exceptions that subclass Google::Gax::Error
+end
+```
+
+New:
+```
+client = Google::Cloud::Kms.key_management_service
+
+parent = "projects/my-project/locations/my-location"
+
+begin
+  response = client.list_key_rings parent: parent, page_size: 10
+rescue Google::Cloud::Error => e
+  # Handle exceptions that subclass Google::Cloud::Error
+end
+```
+
+### Class Namespaces
+
+In older releases, the client object was of classes with names like:
+`Google::Cloud::Kms::V1::KeyManagementServiceClient`.
+In the 2.0 release, the client object is of a different class:
+`Google::Cloud::Kms::V1::KeyManagementService::Client`.
+Note that most users will use the factory methods such as
+`Google::Cloud::Kms.key_management_service` to create instances of the client object,
+so you may not need to reference the actual class directly.
+See [Creating Clients](#creating-clients).
+
+In older releases, the credentials object was of class
+`Google::Cloud::Kms::V1::Credentials`.
+In the 2.0 release, each service has its own credentials class, e.g.
+`Google::Cloud::Kms::V1::KeyManagementService::Credentials`.
+Again, most users will not need to reference this class directly.
+See [Client Configuration](#client-configuration).