google-cloud-recommender 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f81255697ebb7401cb1cbfde5a9cf23e127c885dc93420ed82d55ab3d83b23
-  data.tar.gz: da66f0c876b0a7c391e51d590dfc2183bea29539d22ed948e83eab41771f02bd
+  metadata.gz: 92934b2dbb2b5fc1cec4fbcab92b9755b1d93a6607c7ed7e4b09e6bc434c017a
+  data.tar.gz: 89b18b07e6a38d0ed0dd02be9e42497f0aa221bb88a6c8a9f4299c36e4855e09
 SHA512:
-  metadata.gz: 9009bef5c9364608cb454e2770d280d7784ecc94b146227b5e2432989afbe66c2e28b0772bd839d2706da085a9c7d9a3f95c8ea3c3c6840ac508387ad70fbd36
-  data.tar.gz: b7015e65626e77b13829c43f82ae17cc7a133e1515d9654f1b00e0c37ac3de82763c40969c1b7231740b73c86005b95b0830c108bcb1c82a4086a00875805923
+  metadata.gz: 26c8f744d7c7273deb5b43e634f14635f023f5edcfabd510b4c6cf2a8dc74c559b8d1949f1a3343696b0a2c72140e6025e57bfc679e5ddaf817dcc4250e7fd65
+  data.tar.gz: 2eb0d8b648d228de5e99c44ee505229422c9e8c267d61c0fd89fdc0ef00538acb8bc361ec9f7057feaf7bb81a97b31cb71b6180bf09dfefc800b6fdbc9ef4292

data/README.md

@@ -6,9 +6,10 @@ Recommender is a service on Google Cloud that provides usage recommendations for
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-recommender-v*`.
-The gem `google-cloud-recommender` is a convenience wrapper library that brings the
+The gem `google-cloud-recommender` is the main client library that brings the
 verisoned gems in as dependencies, and provides high-level methods for
-constructing clients.
+constructing clients. More information on versioned clients can be found below
+in the section titled *Which client should I use?*.
 
 View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-recommender/latest)
 for this library, google-cloud-recommender, to see the convenience methods for
@@ -69,3 +70,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-recommender`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-recommender-v1`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-recommender`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-recommender-v1`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google/cloud/recommender/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Recommender
-      VERSION = "1.0.1".freeze
+      VERSION = "1.0.2".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommender
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core