grafeas-v1 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 820f1fd98d2443ae2b1ca7bb07796f96790d2dc6236836659593f13d452747b5
-  data.tar.gz: d552224e7e2e466f88c84162fc5dcf8434c627c3f06224049f475c7fef2c0911
+  metadata.gz: 4c98ba2b171f4df5ab6ba2a9549a4fe05a8cdd3b6ecaa81d1430056d4a517927
+  data.tar.gz: 19c3c16cc8128c9fd3fdea2a752950068d08809a60374d8e5fd882bb5c7e467d
 SHA512:
-  metadata.gz: 1c71f39f90e7e977b2dcd3df98010a6874321984fba16ec77ae3a7321cad55faa3510301043d977364170659915d36617a478b69743f48fefeba746f5ae30909
-  data.tar.gz: 43dcc2ecaf3e5611ed4e9ffd6045ea8283fb769ec6db54f1fcd395b833e832653b2982eb4557b6bcfb826fc21e93d8e24f0a4cd47f9ef17885e4e092d7692c79
+  metadata.gz: 67c6257cdf4b7863a94ad250ad27daa9a49c1337fd6721655e4f9b2ff5931e6a650bd6355bc9727bda945548e33241794ad99af42ab134ac5eb753478c89f9bd
+  data.tar.gz: b34bd16645ba75af30ed522283873675fd794e0a0c5375e198dbaba0afe72419fd0d3ff985d643a93a4b8686a08cf22464cc6874156ba56da1cc2bdad13bad8e

data/README.md

@@ -6,6 +6,12 @@ The Grafeas API stores, and enables querying and retrieval of, critical metadata
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Grafeas V1 API. Most users should consider using
+the main client gem,
+[grafeas](https://rubygems.org/gems/grafeas).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -61,3 +67,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 `grafeas`,
+and lower-level _versioned_ client libraries with names such as
+`grafeas-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.
+`grafeas`.
+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. `grafeas-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/grafeas/v1/version.rb

@@ -19,6 +19,6 @@
 
 module Grafeas
   module V1
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grafeas-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 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: gapic-common
@@ -151,7 +151,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: The Grafeas API stores, and enables querying and retrieval of, critical
-  metadata about all of your software artifacts.
+  metadata about all of your software artifacts. Note that grafeas-v1 is a version-specific
+  client library. For most uses, we recommend installing the main client library grafeas
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []