google-cloud-monitoring-dashboard-v1 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e8fd93bd522d5acadf1844a1c44e027a8b548169a948ce1146d110b611ff042
-  data.tar.gz: 811b983e881ef9ce0fb2b79edcea278f821264577bccb1245be649cbccb25130
+  metadata.gz: d1e84026fed9b96aedb4cf0d2a21db97d825a509242c9f583e7fa79ab2aedae5
+  data.tar.gz: 64610b3b48ee8ee413c58be2b17223a9acaa8a4e05341742453604b6bf07c2a7
 SHA512:
-  metadata.gz: f5ede34d945ece1cbb7776c8ed8615716322d34d03867bb1b244e66287426369ca1e95d2cfeb9b23956d2aebb92694b8916d0c6624f03372bde49c680d15dc09
-  data.tar.gz: 8a501fefb5684f3221fc0d35c3abe834b48f4a4e57f52718a7198f1637e2f457c4a083eccfe51175f84f3c1c242c333cf5bbbef3ae2b15494dcb440a851d58f0
+  metadata.gz: d4e752e28822a931d6bafabe58e65344693432891cc10147b855bc4220bffdd17f9e4a1d9e86a846e60277f8e06e900730771f629091581aca41ada3ba82516f
+  data.tar.gz: fae261f038d4732da68a1428884340e1f782c89e85c76e80cd793f8749ea2534a00a7e440f94a98e9671e3587241ab32e46f5c85bc495dc4af4c65d3e04abfdc

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"

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
@@ -167,12 +164,8 @@ module Google
               # Service calls
 
               ##
-              # Creates a new custom dashboard. For examples on how you can use this API to
-              # create dashboards, see [Managing dashboards by
-              # API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the
-              # `monitoring.dashboards.create` permission on the specified project. For
-              # more information about permissions, see [Cloud Identity and Access
-              # Management](https://cloud.google.com/iam).
+              # Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](/monitoring/dashboards/api-dashboard).
+              # This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](/iam).
               #
               # @overload create_dashboard(request, options = nil)
               #   Pass arguments to `create_dashboard` via a request object, either of type
@@ -184,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).
@@ -197,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]
@@ -486,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.1"
+          VERSION = "0.6.0"
         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/dashboards_service_services_pb.rb

@@ -29,18 +29,14 @@ module Google
             # widgets in a specific layout.
             class Service
 
-              include ::GRPC::GenericService
+              include GRPC::GenericService
 
               self.marshal_class_method = :encode
               self.unmarshal_class_method = :decode
               self.service_name = 'google.monitoring.dashboard.v1.DashboardsService'
 
-              # Creates a new custom dashboard. For examples on how you can use this API to
-              # create dashboards, see [Managing dashboards by
-              # API](https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the
-              # `monitoring.dashboards.create` permission on the specified project. For
-              # more information about permissions, see [Cloud Identity and Access
-              # Management](https://cloud.google.com/iam).
+              # Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](/monitoring/dashboards/api-dashboard).
+              # This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](/iam).
               rpc :CreateDashboard, ::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest, ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
               # Lists the existing dashboards.
               #

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/metrics.rb

@@ -51,9 +51,8 @@ module Google
           # method.
           # @!attribute [rw] filter
           #   @return [::String]
-          #     Required. The [monitoring
-          #     filter](https://cloud.google.com/monitoring/api/v3/filters) that identifies
-          #     the metric types, resources, and projects to query.
+          #     Required. The [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
+          #     that identifies the metric types, resources, and projects to query.
           # @!attribute [rw] aggregation
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Aggregation]
           #     By default, the raw time series data is returned.

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

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

@@ -64,10 +64,10 @@ module Google
             #     which will resolve to the label's value.
             # @!attribute [rw] min_alignment_period
             #   @return [::Google::Protobuf::Duration]
-            #     Optional. The lower bound on data point frequency for this data set,
-            #     implemented by specifying the minimum alignment period to use in a time
-            #     series query. For example, if the data is published once every 10 minutes,
-            #     the `min_alignment_period` should be at least 10 minutes. It would not
+            #     Optional. The lower bound on data point frequency for this data set, implemented by
+            #     specifying the minimum alignment period to use in a time series query
+            #     For example, if the data is published once every 10 minutes, the
+            #     `min_alignment_period` should be at least 10 minutes. It would not
             #     make sense to fetch and align data at one minute intervals.
             class DataSet
               include ::Google::Protobuf::MessageExts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-monitoring-dashboard-v1
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -178,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
@@ -194,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