google-cloud-monitoring-dashboard-v1 0.5.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edf124aa6639e6dce4e181e6318f42380824709f3fc704cd7049bc26b5bffb1b
-  data.tar.gz: c78e5315883cd180c0c30922a9bc624ddb4c5cd3123fffdd6a598462e1d9683c
+  metadata.gz: 8738bc92d8f84c050a3932c6ef0baf8d065aa9c830367e2df76d2ed456bc7137
+  data.tar.gz: 6974c48618cd7b7f529c0397a03023eeea9878e1a429d36a2ed6a79f68208f76
 SHA512:
-  metadata.gz: 45f40e6eec546e1ab0ae5b53258ec459ba532ed990f1de4c97985e7175ab943785eb11ee8a49585d98777b6430f97476654bb211222b7227fe100b7be9879043
-  data.tar.gz: ebf8935b0f4424023e7d68e282b6a55a6af83eb1cb867b695978c8ea6e22c223b5224950bb64ca4b56eba864035137d5bdda1e6c2bb23ebe249dcb6917b2badd
+  metadata.gz: 0a4d65a5d26a840d56a6087504839b6a60e1375b0523a77a9f29220ac26418f43b14302446a62b9380a9d4987736ca1aa8b524a804176426b988397704c187a2
+  data.tar.gz: 8a2bc4b645872f6dca4169b4cbe10495d78ee0bb975c5aed01606d8f52ce62a01e58182c05b01c194009c25ea862bbf4aba8913249062414addd37ea27a27314

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-monitoring-dashboard-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Credentials}):
 
-1. `MONITORING_DASHBOARD_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `MONITORING_DASHBOARD_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `MONITORING_DASHBOARD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `MONITORING_DASHBOARD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/monitoring/dashboard/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.n
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/monitoring/dashboard/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.n
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/monitoring/dashboard/v1"

data/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/monitoring/dashboard/v1"
 
 client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.new
-request = my_create_request
+request = ::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest.new # (request fields as keyword arguments...)
 response = client.create_dashboard request
 ```
 

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

@@ -69,10 +69,7 @@ module Google
 
                   default_config.timeout = 30.0
                   default_config.retry_policy = {
-                    initial_delay: 1.0,
-                  max_delay: 10.0,
-                  multiplier: 1.3,
-                  retry_codes: [14, 2]
+                    initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 2]
                   }
 
                   default_config.rpcs.create_dashboard.timeout = 30.0
@@ -149,7 +146,7 @@ module Google
                                          !@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)
+                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                   credentials = Credentials.new credentials, scope: @config.scope
                 end
                 @quota_project_id = @config.quota_project
@@ -180,7 +177,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload create_dashboard(parent: nil, dashboard: nil)
+              # @overload create_dashboard(parent: nil, dashboard: nil, validate_only: nil)
               #   Pass arguments to `create_dashboard` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -193,6 +190,9 @@ module Google
               #     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.
+              #   @param validate_only [::Boolean]
+              #     If set, validate the request and preview the review, but do not actually
+              #     save it.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
@@ -482,13 +482,16 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
               #
-              # @overload update_dashboard(dashboard: nil)
+              # @overload update_dashboard(dashboard: nil, validate_only: nil)
               #   Pass arguments to `update_dashboard` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param dashboard [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash]
               #     Required. The dashboard that will replace the existing dashboard.
+              #   @param validate_only [::Boolean]
+              #     If set, validate the request and preview the review, but do not actually
+              #     save it.
               #
               # @yield [response, operation] Access the result along with the RPC operation
               # @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]

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

@@ -25,6 +25,23 @@ module Google
           module DashboardsService
             # Path helper methods for the DashboardsService API.
             module Paths
+              ##
+              # Create a fully-qualified AlertPolicy resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}/alertPolicies/{alert_policy}`
+              #
+              # @param project [String]
+              # @param alert_policy [String]
+              #
+              # @return [::String]
+              def alert_policy_path project:, alert_policy:
+                raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+                "projects/#{project}/alertPolicies/#{alert_policy}"
+              end
+
               ##
               # Create a fully-qualified Dashboard resource string.
               #

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

@@ -22,7 +22,7 @@ module Google
     module Monitoring
       module Dashboard
         module V1
-          VERSION = "0.5.0"
+          VERSION = "0.6.2"
         end
       end
     end

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

@@ -0,0 +1,26 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/monitoring/dashboard/v1/alertchart.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/monitoring/dashboard/v1/alertchart.proto", :syntax => :proto3) do
+    add_message "google.monitoring.dashboard.v1.AlertChart" do
+      optional :name, :string, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Monitoring
+      module Dashboard
+        module V1
+          AlertChart = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.AlertChart").msgclass
+        end
+      end
+    end
+  end
+end

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

@@ -15,6 +15,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.monitoring.dashboard.v1.CreateDashboardRequest" do
       optional :parent, :string, 1
       optional :dashboard, :message, 2, "google.monitoring.dashboard.v1.Dashboard"
+      optional :validate_only, :bool, 3
     end
     add_message "google.monitoring.dashboard.v1.ListDashboardsRequest" do
       optional :parent, :string, 1
@@ -33,6 +34,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.monitoring.dashboard.v1.UpdateDashboardRequest" do
       optional :dashboard, :message, 1, "google.monitoring.dashboard.v1.Dashboard"
+      optional :validate_only, :bool, 3
     end
   end
 end

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

@@ -4,6 +4,7 @@
 require 'google/protobuf'
 
 require 'google/api/field_behavior_pb'
+require 'google/monitoring/dashboard/v1/alertchart_pb'
 require 'google/monitoring/dashboard/v1/scorecard_pb'
 require 'google/monitoring/dashboard/v1/text_pb'
 require 'google/monitoring/dashboard/v1/xychart_pb'
@@ -17,6 +18,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :scorecard, :message, 3, "google.monitoring.dashboard.v1.Scorecard"
         optional :text, :message, 4, "google.monitoring.dashboard.v1.Text"
         optional :blank, :message, 5, "google.protobuf.Empty"
+        optional :alert_chart, :message, 7, "google.monitoring.dashboard.v1.AlertChart"
       end
     end
   end

data/proto_docs/google/api/distribution.rb

@@ -49,7 +49,7 @@ module Google
     #
     #         Sum[i=1..n]((x_i - mean)^2)
     #
-    #     Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
+    #     Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
     #     describes Welford's method for accumulating this sum in one pass.
     #
     #     If `count` is zero then this field must be zero.
@@ -207,7 +207,7 @@ module Google
       #   @return [::Array<::Google::Protobuf::Any>]
       #     Contextual information about the example value. Examples are:
       #
-      #       Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
+      #       Trace: type.googleapis.com/google.monitoring.v3.SpanContext
       #
       #       Literal string: type.googleapis.com/google.protobuf.StringValue
       #

data/proto_docs/google/api/field_behavior.rb

@@ -57,9 +57,15 @@ module Google
 
       # 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
+      # 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
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
     end
   end
 end

data/proto_docs/google/monitoring/dashboard/v1/alertchart.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+          # A chart that displays alert policy data.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The resource name of the alert policy. The format is:
+          #
+          #         projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
+          class AlertChart
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/monitoring/dashboard/v1/dashboards_service.rb

@@ -33,6 +33,10 @@ module Google
           # @!attribute [rw] dashboard
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
           #     Required. The initial dashboard specification.
+          # @!attribute [rw] validate_only
+          #   @return [::Boolean]
+          #     If set, validate the request and preview the review, but do not actually
+          #     save it.
           class CreateDashboardRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -100,6 +104,10 @@ module Google
           # @!attribute [rw] dashboard
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
           #     Required. The dashboard that will replace the existing dashboard.
+          # @!attribute [rw] validate_only
+          #   @return [::Boolean]
+          #     If set, validate the request and preview the review, but do not actually
+          #     save it.
           class UpdateDashboardRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/monitoring/dashboard/v1/widget.rb

@@ -39,6 +39,9 @@ module Google
           # @!attribute [rw] blank
           #   @return [::Google::Protobuf::Empty]
           #     A blank space.
+          # @!attribute [rw] alert_chart
+          #   @return [::Google::Cloud::Monitoring::Dashboard::V1::AlertChart]
+          #     A chart of alert policy data.
           class Widget
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-monitoring-dashboard-v1
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-30 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +178,7 @@ files:
 - lib/google/cloud/monitoring/dashboard/v1/dashboards_service/credentials.rb
 - lib/google/cloud/monitoring/dashboard/v1/dashboards_service/paths.rb
 - lib/google/cloud/monitoring/dashboard/v1/version.rb
+- lib/google/monitoring/dashboard/v1/alertchart_pb.rb
 - lib/google/monitoring/dashboard/v1/common_pb.rb
 - lib/google/monitoring/dashboard/v1/dashboard_pb.rb
 - lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb
@@ -188,6 +195,7 @@ files:
 - proto_docs/google/api/distribution.rb
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/monitoring/dashboard/v1/alertchart.rb
 - proto_docs/google/monitoring/dashboard/v1/common.rb
 - proto_docs/google/monitoring/dashboard/v1/dashboard.rb
 - proto_docs/google/monitoring/dashboard/v1/dashboards_service.rb
@@ -221,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Monitoring Dashboards V1 API