google-cloud-retail 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564f33750d3a5cdd4139174118a2b8f6cd1bf57c42e5abf4696d66c6a93188e4
-  data.tar.gz: 1f420ec9bee9ed87614b2103528a52bb5108e41028b12f99e9ad6484f2aae006
+  metadata.gz: 866577ef980fd2cf6a68b7cba79774dbdb4edf33eb9d3ce0edb3a483d490df3b
+  data.tar.gz: e105a42f8390d8b8d293c6fbb1c0ac91ffcf0b192010db95432b3102ec888959
 SHA512:
-  metadata.gz: 5d258c16abd8a3f9723b215311dfff6b9b7d12224a39670711a04be82333dbdf80ae732c68c676647782ee205ea82568fb12ab76b92467d8ffe6d92e08ec0591
-  data.tar.gz: 0403abfabc26701d2f5bd52914fa9b54d3996cffe2565cea075d48fbe116b2c8ff61b8be917d22239a6666f57c734a7ace341f9580e8e0c10fc61b2e4af5fe0b
+  metadata.gz: 148b1cb1387c8abaab910c45106fc1bde9161b30136c3bc094b5cf42206891bf30d9f5582a5f20109f1917b9ab3dcb8fc48487928711acf9fb743e7403d39786
+  data.tar.gz: d3805f80061603a7004571cdee4e82ec2ed760ad214f20cb2d58152a30b0a4e052c221eff355e24eb0a88fa2f738c3e627361a47efb60501aa42b44c777a09d9

data/README.md

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail
 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-19 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core