google-cloud-recommendation_engine 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d416e195589926ed1c1967075a8f716860e8a268a45db0a72441d2082050e5d3
-  data.tar.gz: 48f007776ed6a4d5f4561a821a03649f128a6cff9fb11de9e5d483fe1637d93a
+  metadata.gz: f1e35dbdaedb9bbec1e3160d22215d0b9505d083d1ccf1745fd569ffe2391d14
+  data.tar.gz: d0e87276007a7ff6c6d0f0c780dd7a29fdc55a11246d5da6a64fc839a0a20246
 SHA512:
-  metadata.gz: 61f42860df6196653408150409f6963de7253c27a41f4a88e92dc256cdf96dd17927674aab51dc31e10a456cd9a35f5b5c33108997067d80111dc81625fc9a82
-  data.tar.gz: 8875b1c2f553d7642abf79c5f159f62f64fe17e3f2591c478d515b60b697e2a171a23fca57c1161a28cbc29ce82db4716d17ed16ee8cd527691500ec49b62b86
+  metadata.gz: abc1ebc01aca618c69786bdf7831db1d4f4a89b6b34abeb6149390d003183b3bf149db6f3a07341192bd241c05f9bf3e6541723acbbcb1d859737950ea17fbe4
+  data.tar.gz: e15db332c5f5613f0e08b88086c3f4e92ecb56d0ca963f2bb998e723e5a4a0f3b44e92520e291edbf59fb8c2c838235a57a949d9ab4634eb11f027a7a2c9e62a

data/README.md

@@ -6,9 +6,10 @@ Recommendations AI enables you to build an end-to-end personalized recommendatio
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-recommendation_engine-v*`.
-The gem `google-cloud-recommendation_engine` is a convenience wrapper library that brings the
+The gem `google-cloud-recommendation_engine` 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-recommendation_engine/latest)
 for this library, google-cloud-recommendation_engine, 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-recommendation_engine`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-recommendation_engine-v1beta1`.
+_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-recommendation_engine`.
+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-recommendation_engine-v1beta1`.
+
+### 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/recommendation_engine/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module RecommendationEngine
-      VERSION = "0.1.1"
+      VERSION = "0.1.2"
     end
   end
 end

metadata

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