google-cloud-monitoring-dashboard-v1 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '088aac69873aa23eb240c6f9ceb61c9dd0bdceb28dc9179e9bb55e81587324ef'
-  data.tar.gz: c2f7479b325cd13b300d6e21431e366bbd6ebfe0006812b711414c8fa53d79ab
+  metadata.gz: ce0e451d5b404e797e71ed0dbecddb5bf20a6d4726a3504fcbbf327255d2ba5f
+  data.tar.gz: 71bfc201ec7d6090e1a56b72775df4c82df3d54a1c8dfbe863ad8c84c186a963
 SHA512:
-  metadata.gz: d39e9456b8101d5826d484ce024b15863a779339429f946e0305756d4fcc9d27c90b57ab9f4ad5e79dcdeffbb08bdd6de139b886c6bea707a6ef4f1994247fa1
-  data.tar.gz: 17fcfc0290f170bf7567af7c5a38b5d67e84742ef883dc7e43a3e2ab957370ace851d78638f2f4237c6c2260a03e5642a108c3fcf983d550b11c1d0817fa092e
+  metadata.gz: a456aa0f20d63866acf704df7cf065664dadc17c286ebc14fe223017df6dca002b1884c1ebd9b1104db0f113eb4f44611bb81b8f26588e870a44d20d44b78690
+  data.tar.gz: 542e7f7c82f8727a1035ffd96007f2b9a382aa5760bf5f5b9136f3c7691c4214d710451613c46f944679b0fff142d08081c2a246795593c87c79873b302acda3

data/README.md

@@ -18,6 +18,7 @@ In order to use this library, you first need to go through the following steps:
 
 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+1. [Enable the API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
 ## Quick Start
@@ -33,6 +34,9 @@ response = client.create_dashboard request
 View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-monitoring-dashboard-v1/latest)
 for class and method documentation.
 
+See also the [Product Documentation](https://cloud.google.com/monitoring)
+for general usage information.
+
 ## Enabling Logging
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.

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

@@ -23,6 +23,7 @@ require "gapic/config/method"
 require "google/cloud/monitoring/dashboard/v1/version"
 
 require "google/cloud/monitoring/dashboard/v1/dashboards_service/credentials"
+require "google/cloud/monitoring/dashboard/v1/dashboards_service/paths"
 require "google/cloud/monitoring/dashboard/v1/dashboards_service/client"
 
 module Google

data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb

@@ -32,6 +32,8 @@ module Google
             # widgets in a specific layout.
             #
             class Client
+              include Paths
+
               # @private
               attr_reader :dashboards_service_stub
 
@@ -65,6 +67,20 @@ module Google
                                   end
                   default_config = Client::Configuration.new parent_config
 
+                  default_config.timeout = 30.0
+                  default_config.retry_policy = {
+                    initial_delay: 1.0,
+                    max_delay:     10.0,
+                    multiplier:    1.3,
+                    retry_codes:   [14, 2]
+                  }
+
+                  default_config.rpcs.create_dashboard.timeout = 30.0
+
+                  default_config.rpcs.delete_dashboard.timeout = 30.0
+
+                  default_config.rpcs.update_dashboard.timeout = 30.0
+
                   default_config
                 end
                 yield @configure if block_given?
@@ -167,9 +183,11 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The project on which to execute the request. The format is
-              #     `"projects/{project_id_or_number}"`. The \\{project_id_or_number} must match
-              #     the dashboard resource name.
+              #     Required. The project on which to execute the request. The format is:
+              #
+              #         projects/[PROJECT_ID_OR_NUMBER]
+              #
+              #     The `[PROJECT_ID_OR_NUMBER]` must match the dashboard resource name.
               #   @param dashboard [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash]
               #     Required. The initial dashboard specification.
               #
@@ -241,8 +259,9 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param parent [::String]
-              #     Required. The scope of the dashboards to list. A project scope must be
-              #     specified in the form of `"projects/{project_id_or_number}"`.
+              #     Required. The scope of the dashboards to list. The format is:
+              #
+              #         projects/[PROJECT_ID_OR_NUMBER]
               #   @param page_size [::Integer]
               #     A positive number that is the maximum number of results to return.
               #     If unspecified, a default of 1000 is used.
@@ -320,10 +339,11 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. The resource name of the Dashboard. The format is one of
-              #     `"dashboards/{dashboard_id}"` (for system dashboards) or
-              #     `"projects/{project_id_or_number}/dashboards/{dashboard_id}"`
-              #     (for custom dashboards).
+              #     Required. The resource name of the Dashboard. The format is one of:
+              #
+              #      -  `dashboards/[DASHBOARD_ID]` (for system dashboards)
+              #      -  `projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]`
+              #           (for custom dashboards).
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
@@ -393,8 +413,9 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param name [::String]
-              #     Required. The resource name of the Dashboard. The format is
-              #     `"projects/{project_id_or_number}/dashboards/{dashboard_id}"`.
+              #     Required. The resource name of the Dashboard. The format is:
+              #
+              #         projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Protobuf::Empty]
@@ -596,7 +617,7 @@ module Google
 
                 config_attr :endpoint,      "monitoring.googleapis.com", ::String
                 config_attr :credentials,   nil do |value|
-                  allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
                   allowed.any? { |klass| klass === value }
                 end
@@ -624,7 +645,7 @@ module Google
                 def rpcs
                   @rpcs ||= begin
                     parent_rpcs = nil
-                    parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
                     Rpcs.new parent_rpcs
                   end
                 end

data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/paths.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Monitoring
+      module Dashboard
+        module V1
+          module DashboardsService
+            # Path helper methods for the DashboardsService API.
+            module Paths
+              ##
+              # Create a fully-qualified Dashboard resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/dashboards/{dashboard}`
+              #
+              # @param project [String]
+              # @param dashboard [String]
+              #
+              # @return [::String]
+              def dashboard_path project:, dashboard:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                "projects/#{project}/dashboards/#{dashboard}"
+              end
+
+              ##
+              # Create a fully-qualified Project resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}`
+              #
+              # @param project [String]
+              #
+              # @return [::String]
+              def project_path project:
+                "projects/#{project}"
+              end
+
+              extend self
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ module Google
     module Monitoring
       module Dashboard
         module V1
-          VERSION = "0.1.0"
+          VERSION = "0.2.3"
         end
       end
     end

data/lib/google/monitoring/dashboard/v1/common_pb.rb

@@ -3,6 +3,7 @@
 
 require 'google/protobuf'
 
+require 'google/api/distribution_pb'
 require 'google/protobuf/duration_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/monitoring/dashboard/v1/common.proto", :syntax => :proto3) do

data/lib/google/monitoring/dashboard/v1/dashboard_pb.rb

@@ -3,6 +3,8 @@
 
 require 'google/protobuf'
 
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
 require 'google/monitoring/dashboard/v1/layouts_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/monitoring/dashboard/v1/dashboard.proto", :syntax => :proto3) do

data/lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb

@@ -5,6 +5,7 @@ require 'google/protobuf'
 
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
 require 'google/monitoring/dashboard/v1/dashboard_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'

data/lib/google/monitoring/dashboard/v1/dashboards_service_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/monitoring/dashboard/v1/dashboards_service.proto for package 'Google.Cloud.Monitoring.Dashboard.V1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2020 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 require 'grpc'
 require 'google/monitoring/dashboard/v1/dashboards_service_pb'

data/lib/google/monitoring/dashboard/v1/drilldowns_pb.rb

@@ -3,6 +3,7 @@
 
 require 'google/protobuf'
 
+require 'google/monitoring/dashboard/v1/common_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/monitoring/dashboard/v1/drilldowns.proto", :syntax => :proto3) do
   end

data/lib/google/monitoring/dashboard/v1/metrics_pb.rb

@@ -12,11 +12,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       oneof :source do
         optional :time_series_filter, :message, 1, "google.monitoring.dashboard.v1.TimeSeriesFilter"
         optional :time_series_filter_ratio, :message, 2, "google.monitoring.dashboard.v1.TimeSeriesFilterRatio"
+        optional :time_series_query_language, :string, 3
       end
     end
     add_message "google.monitoring.dashboard.v1.TimeSeriesFilter" do
       optional :filter, :string, 1
       optional :aggregation, :message, 2, "google.monitoring.dashboard.v1.Aggregation"
+      optional :secondary_aggregation, :message, 3, "google.monitoring.dashboard.v1.Aggregation"
       oneof :output_filter do
         optional :pick_time_series_filter, :message, 4, "google.monitoring.dashboard.v1.PickTimeSeriesFilter"
         optional :statistical_time_series_filter, :message, 5, "google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter"

data/lib/google/monitoring/dashboard/v1/scorecard_pb.rb

@@ -3,6 +3,7 @@
 
 require 'google/protobuf'
 
+require 'google/api/field_behavior_pb'
 require 'google/monitoring/dashboard/v1/metrics_pb'
 require 'google/protobuf/duration_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do

data/proto_docs/google/api/distribution.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Api
+    # `Distribution` contains summary statistics for a population of values. It
+    # optionally contains a histogram representing the distribution of those values
+    # across a set of buckets.
+    #
+    # The summary statistics are the count, mean, sum of the squared deviation from
+    # the mean, the minimum, and the maximum of the set of population of values.
+    # The histogram is based on a sequence of buckets and gives a count of values
+    # that fall into each bucket. The boundaries of the buckets are given either
+    # explicitly or by formulas for buckets of fixed or exponentially increasing
+    # widths.
+    #
+    # Although it is not forbidden, it is generally a bad idea to include
+    # non-finite values (infinities or NaNs) in the population of values, as this
+    # will render the `mean` and `sum_of_squared_deviation` fields meaningless.
+    # @!attribute [rw] count
+    #   @return [::Integer]
+    #     The number of values in the population. Must be non-negative. This value
+    #     must equal the sum of the values in `bucket_counts` if a histogram is
+    #     provided.
+    # @!attribute [rw] mean
+    #   @return [::Float]
+    #     The arithmetic mean of the values in the population. If `count` is zero
+    #     then this field must be zero.
+    # @!attribute [rw] sum_of_squared_deviation
+    #   @return [::Float]
+    #     The sum of squared deviations from the mean of the values in the
+    #     population. For values x_i this is:
+    #
+    #         Sum[i=1..n]((x_i - mean)^2)
+    #
+    #     Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
+    #     describes Welford's method for accumulating this sum in one pass.
+    #
+    #     If `count` is zero then this field must be zero.
+    # @!attribute [rw] range
+    #   @return [::Google::Api::Distribution::Range]
+    #     If specified, contains the range of the population values. The field
+    #     must not be present if the `count` is zero.
+    # @!attribute [rw] bucket_options
+    #   @return [::Google::Api::Distribution::BucketOptions]
+    #     Defines the histogram bucket boundaries. If the distribution does not
+    #     contain a histogram, then omit this field.
+    # @!attribute [rw] bucket_counts
+    #   @return [::Array<::Integer>]
+    #     The number of values in each bucket of the histogram, as described in
+    #     `bucket_options`. If the distribution does not have a histogram, then omit
+    #     this field. If there is a histogram, then the sum of the values in
+    #     `bucket_counts` must equal the value in the `count` field of the
+    #     distribution.
+    #
+    #     If present, `bucket_counts` should contain N values, where N is the number
+    #     of buckets specified in `bucket_options`. If you supply fewer than N
+    #     values, the remaining values are assumed to be 0.
+    #
+    #     The order of the values in `bucket_counts` follows the bucket numbering
+    #     schemes described for the three bucket types. The first value must be the
+    #     count for the underflow bucket (number 0). The next N-2 values are the
+    #     counts for the finite buckets (number 1 through N-2). The N'th value in
+    #     `bucket_counts` is the count for the overflow bucket (number N-1).
+    # @!attribute [rw] exemplars
+    #   @return [::Array<::Google::Api::Distribution::Exemplar>]
+    #     Must be in increasing order of `value` field.
+    class Distribution
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # The range of the population values.
+      # @!attribute [rw] min
+      #   @return [::Float]
+      #     The minimum of the population values.
+      # @!attribute [rw] max
+      #   @return [::Float]
+      #     The maximum of the population values.
+      class Range
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # `BucketOptions` describes the bucket boundaries used to create a histogram
+      # for the distribution. The buckets can be in a linear sequence, an
+      # exponential sequence, or each bucket can be specified explicitly.
+      # `BucketOptions` does not include the number of values in each bucket.
+      #
+      # A bucket has an inclusive lower bound and exclusive upper bound for the
+      # values that are counted for that bucket. The upper bound of a bucket must
+      # be strictly greater than the lower bound. The sequence of N buckets for a
+      # distribution consists of an underflow bucket (number 0), zero or more
+      # finite buckets (number 1 through N - 2) and an overflow bucket (number N -
+      # 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
+      # same as the upper bound of bucket i - 1. The buckets span the whole range
+      # of finite values: lower bound of the underflow bucket is -infinity and the
+      # upper bound of the overflow bucket is +infinity. The finite buckets are
+      # so-called because both bounds are finite.
+      # @!attribute [rw] linear_buckets
+      #   @return [::Google::Api::Distribution::BucketOptions::Linear]
+      #     The linear bucket.
+      # @!attribute [rw] exponential_buckets
+      #   @return [::Google::Api::Distribution::BucketOptions::Exponential]
+      #     The exponential buckets.
+      # @!attribute [rw] explicit_buckets
+      #   @return [::Google::Api::Distribution::BucketOptions::Explicit]
+      #     The explicit buckets.
+      class BucketOptions
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+
+        # Specifies a linear sequence of buckets that all have the same width
+        # (except overflow and underflow). Each bucket represents a constant
+        # absolute uncertainty on the specific value in the bucket.
+        #
+        # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
+        # following boundaries:
+        #
+        #    Upper bound (0 <= i < N-1):     offset + (width * i).
+        #    Lower bound (1 <= i < N):       offset + (width * (i - 1)).
+        # @!attribute [rw] num_finite_buckets
+        #   @return [::Integer]
+        #     Must be greater than 0.
+        # @!attribute [rw] width
+        #   @return [::Float]
+        #     Must be greater than 0.
+        # @!attribute [rw] offset
+        #   @return [::Float]
+        #     Lower bound of the first bucket.
+        class Linear
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies an exponential sequence of buckets that have a width that is
+        # proportional to the value of the lower bound. Each bucket represents a
+        # constant relative uncertainty on a specific value in the bucket.
+        #
+        # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
+        # following boundaries:
+        #
+        #    Upper bound (0 <= i < N-1):     scale * (growth_factor ^ i).
+        #    Lower bound (1 <= i < N):       scale * (growth_factor ^ (i - 1)).
+        # @!attribute [rw] num_finite_buckets
+        #   @return [::Integer]
+        #     Must be greater than 0.
+        # @!attribute [rw] growth_factor
+        #   @return [::Float]
+        #     Must be greater than 1.
+        # @!attribute [rw] scale
+        #   @return [::Float]
+        #     Must be greater than 0.
+        class Exponential
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Specifies a set of buckets with arbitrary widths.
+        #
+        # There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
+        # boundaries:
+        #
+        #    Upper bound (0 <= i < N-1):     bounds[i]
+        #    Lower bound (1 <= i < N);       bounds[i - 1]
+        #
+        # The `bounds` field must contain at least one element. If `bounds` has
+        # only one element, then there are no finite buckets, and that single
+        # element is the common boundary of the overflow and underflow buckets.
+        # @!attribute [rw] bounds
+        #   @return [::Array<::Float>]
+        #     The values must be monotonically increasing.
+        class Explicit
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+
+      # Exemplars are example points that may be used to annotate aggregated
+      # distribution values. They are metadata that gives information about a
+      # particular value added to a Distribution bucket, such as a trace ID that
+      # was active when a value was added. They may contain further information,
+      # such as a example values and timestamps, origin, etc.
+      # @!attribute [rw] value
+      #   @return [::Float]
+      #     Value of the exemplar point. This value determines to which bucket the
+      #     exemplar belongs.
+      # @!attribute [rw] timestamp
+      #   @return [::Google::Protobuf::Timestamp]
+      #     The observation (sampling) time of the above value.
+      # @!attribute [rw] attachments
+      #   @return [::Array<::Google::Protobuf::Any>]
+      #     Contextual information about the example value. Examples are:
+      #
+      #       Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
+      #
+      #       Literal string: type.googleapis.com/google.protobuf.StringValue
+      #
+      #       Labels dropped during aggregation:
+      #         type.googleapis.com/google.monitoring.v3.DroppedLabels
+      #
+      #     There may be only a single attachment of any given message type in a
+      #     single exemplar, and this is enforced by the system.
+      class Exemplar
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+    end
+  end
+end