google-cloud-monitoring-dashboard-v1 0.1.1 → 0.2.0

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

@@ -26,10 +26,10 @@ module Google
           # of pages in the Stackdriver web application.
           # @!attribute [rw] name
           #   @return [::String]
-          #     The resource name of the dashboard.
+          #     Immutable. The resource name of the dashboard.
           # @!attribute [rw] display_name
           #   @return [::String]
-          #     The mutable, human-readable name.
+          #     Required. The mutable, human-readable name.
           # @!attribute [rw] etag
           #   @return [::String]
           #     `etag` is used for optimistic concurrency control as a way to help

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

@@ -25,9 +25,11 @@ module Google
           # The `CreateDashboard` request.
           # @!attribute [rw] parent
           #   @return [::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.
           # @!attribute [rw] dashboard
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
           #     Required. The initial dashboard specification.
@@ -39,8 +41,9 @@ module Google
           # The `ListDashboards` request.
           # @!attribute [rw] parent
           #   @return [::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]
           # @!attribute [rw] page_size
           #   @return [::Integer]
           #     A positive number that is the maximum number of results to return.
@@ -63,7 +66,7 @@ module Google
           #   @return [::String]
           #     If there are more results than have been returned, then this field is set
           #     to a non-empty value.  To see the additional results,
-          #     use that value as `pageToken` in the next call to this method.
+          #     use that value as `page_token` in the next call to this method.
           class ListDashboardsResponse
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -72,10 +75,11 @@ module Google
           # The `GetDashboard` request.
           # @!attribute [rw] name
           #   @return [::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).
           class GetDashboardRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -84,8 +88,9 @@ module Google
           # The `DeleteDashboard` request.
           # @!attribute [rw] name
           #   @return [::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]
           class DeleteDashboardRequest
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -30,6 +30,9 @@ module Google
           # @!attribute [rw] time_series_filter_ratio
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio]
           #     Parameters to fetch a ratio between two time series filters.
+          # @!attribute [rw] time_series_query_language
+          #   @return [::String]
+          #     A query used to fetch time series.
           # @!attribute [rw] unit_override
           #   @return [::String]
           #     The unit of data contained in fetched time series. If non-empty, this
@@ -48,19 +51,23 @@ 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.
           #     Use this field to combine multiple time series for different views of the
           #     data.
+          # @!attribute [rw] secondary_aggregation
+          #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Aggregation]
+          #     Apply a second aggregation after `aggregation` is applied.
           # @!attribute [rw] pick_time_series_filter
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter]
           #     Ranking based time series filter.
           # @!attribute [rw] statistical_time_series_filter
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
           #     Statistics based time series filter.
+          #     Note: This field is deprecated and completely ignored by the API.
           class TimeSeriesFilter
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -84,6 +91,7 @@ module Google
           # @!attribute [rw] statistical_time_series_filter
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
           #     Statistics based time series filter.
+          #     Note: This field is deprecated and completely ignored by the API.
           class TimeSeriesFilterRatio
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -92,8 +100,9 @@ module Google
             # TimeSeriesFilterRatio.
             # @!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/scorecard.rb

@@ -26,7 +26,7 @@ module Google
           # one or more thresholds.
           # @!attribute [rw] time_series_query
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
-          #     Fields for querying time series data from the
+          #     Required. Fields for querying time series data from the
           #     Stackdriver metrics API.
           # @!attribute [rw] gauge_view
           #   @return [::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::GaugeView]
@@ -97,7 +97,7 @@ module Google
             # timeseries.
             # @!attribute [rw] spark_chart_type
             #   @return [::Google::Cloud::Monitoring::Dashboard::V1::SparkChartType]
-            #     The type of sparkchart to show in this chartView.
+            #     Required. The type of sparkchart to show in this chartView.
             # @!attribute [rw] min_alignment_period
             #   @return [::Google::Protobuf::Duration]
             #     The lower bound on data point frequency in the chart implemented by

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

@@ -25,7 +25,7 @@ module Google
           # A chart that displays data on a 2D (X and Y axes) plane.
           # @!attribute [rw] data_sets
           #   @return [::Array<::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet>]
-          #     The data displayed in this chart.
+          #     Required. The data displayed in this chart.
           # @!attribute [rw] timeshift_duration
           #   @return [::Google::Protobuf::Duration]
           #     The duration used to display a comparison chart. A comparison chart
@@ -52,7 +52,7 @@ module Google
             # Groups a time series query definition with charting options.
             # @!attribute [rw] time_series_query
             #   @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery]
-            #     Fields for querying time series data from the
+            #     Required. Fields for querying time series data from the
             #     Stackdriver metrics API.
             # @!attribute [rw] plot_type
             #   @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart::DataSet::PlotType]
@@ -60,7 +60,7 @@ module Google
             # @!attribute [rw] legend_template
             #   @return [::String]
             #     A template string for naming `TimeSeries` in the resulting data set.
-            #     This should be a string with interpolations of the form $\\{label_name},
+            #     This should be a string with interpolations of the form `${label_name}`,
             #     which will resolve to the label's value.
             # @!attribute [rw] min_alignment_period
             #   @return [::Google::Protobuf::Duration]

data/proto_docs/google/protobuf/any.rb

@@ -0,0 +1,138 @@
+# 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 Protobuf
+    # `Any` contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # JSON
+    # ====
+    # The JSON representation of an `Any` value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field `@type` which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # `value` which holds the custom JSON in addition to the `@type`
+    # field. Example (for message [google.protobuf.Duration][]):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [::String]
+    #     A URL/resource name that uniquely identifies the type of the serialized
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
+    #     the fully qualified name of the type (as in
+    #     `path/google.protobuf.Duration`). The name should be in a canonical form
+    #     (e.g., leading "." is not accepted).
+    #
+    #     In practice, teams usually precompile into the binary all types that they
+    #     expect it to use in the context of Any. However, for URLs which use the
+    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
+    #     server that maps type URLs to message definitions as follows:
+    #
+    #     * If no scheme is provided, `https` is assumed.
+    #     * An HTTP GET on the URL must yield a [google.protobuf.Type][]
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Note: this functionality is not currently available in the official
+    #     protobuf release, and it is not used for type URLs beginning with
+    #     type.googleapis.com.
+    #
+    #     Schemes other than `http`, `https` (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [::String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/protobuf/timestamp.rb

@@ -0,0 +1,120 @@
+# 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 Protobuf
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+    # restricting to that range, we ensure that we can convert to and from [RFC
+    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Timestamp from POSIX `time()`.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    #
+    # Example 5: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard
+    # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+    # method. In Python, a standard `datetime.datetime` object can be converted
+    # to this format using
+    # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+    # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+    # the Joda Time's [`ISODateTimeFormat.dateTime()`](
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
+    # ) to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-monitoring-dashboard-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-08 00:00:00.000000000 Z
+date: 2020-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -167,6 +167,7 @@ files:
 - lib/google/cloud/monitoring/dashboard/v1/dashboards_service.rb
 - lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb
 - 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/common_pb.rb
 - lib/google/monitoring/dashboard/v1/dashboard_pb.rb
@@ -181,6 +182,7 @@ files:
 - lib/google/monitoring/dashboard/v1/widget_pb.rb
 - lib/google/monitoring/dashboard/v1/xychart_pb.rb
 - proto_docs/README.md
+- 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/common.rb
@@ -192,9 +194,11 @@ files:
 - proto_docs/google/monitoring/dashboard/v1/text.rb
 - proto_docs/google/monitoring/dashboard/v1/widget.rb
 - proto_docs/google/monitoring/dashboard/v1/xychart.rb
+- proto_docs/google/protobuf/any.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/empty.rb
 - proto_docs/google/protobuf/field_mask.rb
+- proto_docs/google/protobuf/timestamp.rb
 homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0