google-cloud-monitoring-dashboard-v1 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8c843cceb139c4571f47f89c31f0e8babe4b3d0c33d2b3d355321602442c100
-  data.tar.gz: a86b25bb91eaa91db6e4e1e4890c39ec106be9be0d913536d54ae6aeb24f7ed4
+  metadata.gz: d5b908f743ed4fe14126b7c127bc9cfa41a8052f66897b2e3d5b0b7e0f9d8350
+  data.tar.gz: 80b374a94e13df08238943eb7b9f7cbc347582040e63764b72104e89de7d06e2
 SHA512:
-  metadata.gz: 57ba3e943b62b08dc007ccc81fa8a50a16e055fdc55666d0d3a0e08b5604e0dbeea85a247e4af98a4e4c1e22383ce23eee95f327ad6cd5955e80d84accce9ac8
-  data.tar.gz: 3834ce01aa1d39bbf605611f4a2c4077a36395488182a038643b7cbede142f1159a13f2add3a8f7be2e6669d37ddb34f22748ef6013d76413c9bf4a87816d455
+  metadata.gz: b7fcb6a236969cab315bf0f81c822a417e63b5cd50a0818e29680afe9ee83b48a76038e8b369910c27f2a8d173383a9cd4e066358a442389b96c49878a0699f7
+  data.tar.gz: 54b057dd50e91752f230138316495d7d74d1ac678a07110ba408b2023143ce21e2cf5de5a8aa644d1018743b07d920c6161fbaecd5534f3125d2d3abd2065b78

data/README.md

@@ -6,6 +6,12 @@ Cloud Monitoring collects metrics, events, and metadata from Google Cloud, Amazo
 
 https://github.com/googleapis/google-cloud-ruby
 
+This gem is a _versioned_ client. It provides basic client classes for a
+specific version of the Cloud Monitoring Dashboards V1 API. Most users should consider using
+the main client gem,
+[google-cloud-monitoring-dashboard](https://rubygems.org/gems/google-cloud-monitoring-dashboard).
+See the section below titled *Which client should I use?* for more information.
+
 ## Installation
 
 ```
@@ -73,3 +79,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-monitoring-dashboard`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-monitoring-dashboard-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-monitoring-dashboard`.
+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-monitoring-dashboard-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/monitoring/dashboard/v1/dashboards_service/client.rb

@@ -142,7 +142,13 @@ module Google
 
                 # Create credentials
                 credentials = @config.credentials
-                credentials ||= Credentials.default scope: @config.scope
+                # Use self-signed JWT if the scope and endpoint are unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.scope == Client.configure.scope &&
+                                         @config.endpoint == Client.configure.endpoint &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope:                  @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(String) || credentials.is_a?(Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end

data/lib/google/cloud/monitoring/dashboard/v1/version.rb

@@ -22,7 +22,7 @@ module Google
     module Monitoring
       module Dashboard
         module V1
-          VERSION = "0.2.4"
+          VERSION = "0.3.0"
         end
       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: google-cloud-monitoring-dashboard-v1
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 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
@@ -152,7 +152,10 @@ dependencies:
         version: '0.9'
 description: Cloud Monitoring collects metrics, events, and metadata from Google Cloud,
   Amazon Web Services (AWS), hosted uptime probes, and application instrumentation.
-  The Dashboards API manages arrangements of display widgets.
+  The Dashboards API manages arrangements of display widgets. Note that google-cloud-monitoring-dashboard-v1
+  is a version-specific client library. For most uses, we recommend installing the
+  main client library google-cloud-monitoring-dashboard instead. See the readme for
+  more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []