google-cloud-monitoring 0.38.0 → 1.0.0

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

@@ -1,82 +0,0 @@
-# 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.
-
-
-module Google
-  module Monitoring
-    module Dashboard
-      module V1
-        # 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.
-        # @!attribute [rw] dashboard
-        #   @return [Google::Monitoring::Dashboard::V1::Dashboard]
-        #     Required. The initial dashboard specification.
-        class CreateDashboardRequest; end
-
-        # 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}"`.
-        # @!attribute [rw] page_size
-        #   @return [Integer]
-        #     A positive number that is the maximum number of results to return.
-        #     If unspecified, a default of 1000 is used.
-        # @!attribute [rw] page_token
-        #   @return [String]
-        #     If this field is not empty then it must contain the `nextPageToken` value
-        #     returned by a previous call to this method.  Using this field causes the
-        #     method to return additional results from the previous method call.
-        class ListDashboardsRequest; end
-
-        # The `ListDashboards` request.
-        # @!attribute [rw] dashboards
-        #   @return [Array<Google::Monitoring::Dashboard::V1::Dashboard>]
-        #     The list of requested dashboards.
-        # @!attribute [rw] next_page_token
-        #   @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.
-        class ListDashboardsResponse; end
-
-        # 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).
-        class GetDashboardRequest; end
-
-        # 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}"`.
-        class DeleteDashboardRequest; end
-
-        # The `UpdateDashboard` request.
-        # @!attribute [rw] dashboard
-        #   @return [Google::Monitoring::Dashboard::V1::Dashboard]
-        #     Required. The dashboard that will replace the existing dashboard.
-        class UpdateDashboardRequest; end
-      end
-    end
-  end
-end

data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/layouts.rb

@@ -1,71 +0,0 @@
-# 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.
-
-
-module Google
-  module Monitoring
-    module Dashboard
-      module V1
-        # A basic layout divides the available space into vertical columns of equal
-        # width and arranges a list of widgets using a row-first strategy.
-        # @!attribute [rw] columns
-        #   @return [Integer]
-        #     The number of columns into which the view's width is divided. If omitted
-        #     or set to zero, a system default will be used while rendering.
-        # @!attribute [rw] widgets
-        #   @return [Array<Google::Monitoring::Dashboard::V1::Widget>]
-        #     The informational elements that are arranged into the columns row-first.
-        class GridLayout; end
-
-        # A simplified layout that divides the available space into rows
-        # and arranges a set of widgets horizontally in each row.
-        # @!attribute [rw] rows
-        #   @return [Array<Google::Monitoring::Dashboard::V1::RowLayout::Row>]
-        #     The rows of content to display.
-        class RowLayout
-          # Defines the layout properties and content for a row.
-          # @!attribute [rw] weight
-          #   @return [Integer]
-          #     The relative weight of this row. The row weight is used to adjust the
-          #     height of rows on the screen (relative to peers). Greater the weight,
-          #     greater the height of the row on the screen. If omitted, a value
-          #     of 1 is used while rendering.
-          # @!attribute [rw] widgets
-          #   @return [Array<Google::Monitoring::Dashboard::V1::Widget>]
-          #     The display widgets arranged horizontally in this row.
-          class Row; end
-        end
-
-        # A simplified layout that divides the available space into vertical columns
-        # and arranges a set of widgets vertically in each column.
-        # @!attribute [rw] columns
-        #   @return [Array<Google::Monitoring::Dashboard::V1::ColumnLayout::Column>]
-        #     The columns of content to display.
-        class ColumnLayout
-          # Defines the layout properties and content for a column.
-          # @!attribute [rw] weight
-          #   @return [Integer]
-          #     The relative weight of this column. The column weight is used to adjust
-          #     the width of columns on the screen (relative to peers).
-          #     Greater the weight, greater the width of the column on the screen.
-          #     If omitted, a value of 1 is used while rendering.
-          # @!attribute [rw] widgets
-          #   @return [Array<Google::Monitoring::Dashboard::V1::Widget>]
-          #     The display widgets arranged vertically in this column.
-          class Column; end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/metrics.rb

@@ -1,151 +0,0 @@
-# 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.
-
-
-module Google
-  module Monitoring
-    module Dashboard
-      module V1
-        # TimeSeriesQuery collects the set of supported methods for querying time
-        # series data from the Stackdriver metrics API.
-        # @!attribute [rw] time_series_filter
-        #   @return [Google::Monitoring::Dashboard::V1::TimeSeriesFilter]
-        #     Filter parameters to fetch time series.
-        # @!attribute [rw] time_series_filter_ratio
-        #   @return [Google::Monitoring::Dashboard::V1::TimeSeriesFilterRatio]
-        #     Parameters to fetch a ratio between two time series filters.
-        # @!attribute [rw] unit_override
-        #   @return [String]
-        #     The unit of data contained in fetched time series. If non-empty, this
-        #     unit will override any unit that accompanies fetched data. The format is
-        #     the same as the
-        #     [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
-        #     field in `MetricDescriptor`.
-        class TimeSeriesQuery; end
-
-        # A filter that defines a subset of time series data that is displayed in a
-        # widget. Time series data is fetched using the
-        # [`ListTimeSeries`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
-        # 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.
-        # @!attribute [rw] aggregation
-        #   @return [Google::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] pick_time_series_filter
-        #   @return [Google::Monitoring::Dashboard::V1::PickTimeSeriesFilter]
-        #     Ranking based time series filter.
-        # @!attribute [rw] statistical_time_series_filter
-        #   @return [Google::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
-        #     Statistics based time series filter.
-        class TimeSeriesFilter; end
-
-        # A pair of time series filters that define a ratio computation. The output
-        # time series is the pair-wise division of each aligned element from the
-        # numerator and denominator time series.
-        # @!attribute [rw] numerator
-        #   @return [Google::Monitoring::Dashboard::V1::TimeSeriesFilterRatio::RatioPart]
-        #     The numerator of the ratio.
-        # @!attribute [rw] denominator
-        #   @return [Google::Monitoring::Dashboard::V1::TimeSeriesFilterRatio::RatioPart]
-        #     The denominator of the ratio.
-        # @!attribute [rw] secondary_aggregation
-        #   @return [Google::Monitoring::Dashboard::V1::Aggregation]
-        #     Apply a second aggregation after the ratio is computed.
-        # @!attribute [rw] pick_time_series_filter
-        #   @return [Google::Monitoring::Dashboard::V1::PickTimeSeriesFilter]
-        #     Ranking based time series filter.
-        # @!attribute [rw] statistical_time_series_filter
-        #   @return [Google::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
-        #     Statistics based time series filter.
-        class TimeSeriesFilterRatio
-          # Describes a query to build the numerator or denominator of a
-          # 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.
-          # @!attribute [rw] aggregation
-          #   @return [Google::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.
-          class RatioPart; end
-        end
-
-        # Defines a threshold for categorizing time series values.
-        # @!attribute [rw] label
-        #   @return [String]
-        #     A label for the threshold.
-        # @!attribute [rw] value
-        #   @return [Float]
-        #     The value of the threshold. The value should be defined in the native scale
-        #     of the metric.
-        # @!attribute [rw] color
-        #   @return [Google::Monitoring::Dashboard::V1::Threshold::Color]
-        #     The state color for this threshold. Color is not allowed in a XyChart.
-        # @!attribute [rw] direction
-        #   @return [Google::Monitoring::Dashboard::V1::Threshold::Direction]
-        #     The direction for the current threshold. Direction is not allowed in a
-        #     XyChart.
-        class Threshold
-          # The color suggests an interpretation to the viewer when actual values cross
-          # the threshold. Comments on each color provide UX guidance on how users can
-          # be expected to interpret a given state color.
-          module Color
-            # Color is unspecified. Not allowed in well-formed requests.
-            COLOR_UNSPECIFIED = 0
-
-            # Crossing the threshold is "concerning" behavior.
-            YELLOW = 4
-
-            # Crossing the threshold is "emergency" behavior.
-            RED = 6
-          end
-
-          # Whether the threshold is considered crossed by an actual value above or
-          # below its threshold value.
-          module Direction
-            # Not allowed in well-formed requests.
-            DIRECTION_UNSPECIFIED = 0
-
-            # The threshold will be considered crossed if the actual value is above
-            # the threshold value.
-            ABOVE = 1
-
-            # The threshold will be considered crossed if the actual value is below
-            # the threshold value.
-            BELOW = 2
-          end
-        end
-
-        # Defines the possible types of spark chart supported by the `Scorecard`.
-        module SparkChartType
-          # Not allowed in well-formed requests.
-          SPARK_CHART_TYPE_UNSPECIFIED = 0
-
-          # The sparkline will be rendered as a small line chart.
-          SPARK_LINE = 1
-
-          # The sparkbar will be rendered as a small bar chart.
-          SPARK_BAR = 2
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/scorecard.rb

@@ -1,102 +0,0 @@
-# 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.
-
-
-module Google
-  module Monitoring
-    module Dashboard
-      module V1
-        # A widget showing the latest value of a metric, and how this value relates to
-        # one or more thresholds.
-        # @!attribute [rw] time_series_query
-        #   @return [Google::Monitoring::Dashboard::V1::TimeSeriesQuery]
-        #     Fields for querying time series data from the
-        #     Stackdriver metrics API.
-        # @!attribute [rw] gauge_view
-        #   @return [Google::Monitoring::Dashboard::V1::Scorecard::GaugeView]
-        #     Will cause the scorecard to show a gauge chart.
-        # @!attribute [rw] spark_chart_view
-        #   @return [Google::Monitoring::Dashboard::V1::Scorecard::SparkChartView]
-        #     Will cause the scorecard to show a spark chart.
-        # @!attribute [rw] thresholds
-        #   @return [Array<Google::Monitoring::Dashboard::V1::Threshold>]
-        #     The thresholds used to determine the state of the scorecard given the
-        #     time series' current value. For an actual value x, the scorecard is in a
-        #     danger state if x is less than or equal to a danger threshold that triggers
-        #     below, or greater than or equal to a danger threshold that triggers above.
-        #     Similarly, if x is above/below a warning threshold that triggers
-        #     above/below, then the scorecard is in a warning state - unless x also puts
-        #     it in a danger state. (Danger trumps warning.)
-        #
-        #     As an example, consider a scorecard with the following four thresholds:
-        #     {
-        #       value: 90,
-        #       category: 'DANGER',
-        #       trigger: 'ABOVE',
-        #     },
-        #     {
-        #       value: 70,
-        #       category: 'WARNING',
-        #       trigger: 'ABOVE',
-        #     },
-        #     {
-        #       value: 10,
-        #       category: 'DANGER',
-        #       trigger: 'BELOW',
-        #     },
-        #     {
-        #       value: 20,
-        #       category: 'WARNING',
-        #       trigger: 'BELOW',
-        #     }
-        #
-        #     Then: values less than or equal to 10 would put the scorecard in a DANGER
-        #     state, values greater than 10 but less than or equal to 20 a WARNING state,
-        #     values strictly between 20 and 70 an OK state, values greater than or equal
-        #     to 70 but less than 90 a WARNING state, and values greater than or equal to
-        #     90 a DANGER state.
-        class Scorecard
-          # A gauge chart shows where the current value sits within a pre-defined
-          # range. The upper and lower bounds should define the possible range of
-          # values for the scorecard's query (inclusive).
-          # @!attribute [rw] lower_bound
-          #   @return [Float]
-          #     The lower bound for this gauge chart. The value of the chart should
-          #     always be greater than or equal to this.
-          # @!attribute [rw] upper_bound
-          #   @return [Float]
-          #     The upper bound for this gauge chart. The value of the chart should
-          #     always be less than or equal to this.
-          class GaugeView; end
-
-          # A sparkChart is a small chart suitable for inclusion in a table-cell or
-          # inline in text. This message contains the configuration for a sparkChart
-          # to show up on a Scorecard, showing recent trends of the scorecard's
-          # timeseries.
-          # @!attribute [rw] spark_chart_type
-          #   @return [Google::Monitoring::Dashboard::V1::SparkChartType]
-          #     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
-          #     specifying the minimum alignment period to use in a time series query.
-          #     For example, if the data is published once every 10 minutes it would not
-          #     make sense to fetch and align data at one minute intervals. This field is
-          #     optional and exists only as a hint.
-          class SparkChartView; end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/monitoring/dashboard/v1/doc/google/monitoring/dashboard/v1/text.rb

@@ -1,43 +0,0 @@
-# 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.
-
-
-module Google
-  module Monitoring
-    module Dashboard
-      module V1
-        # A widget that displays textual content.
-        # @!attribute [rw] content
-        #   @return [String]
-        #     The text content to be displayed.
-        # @!attribute [rw] format
-        #   @return [Google::Monitoring::Dashboard::V1::Text::Format]
-        #     How the text content is formatted.
-        class Text
-          # The format type of the text content.
-          module Format
-            # Format is unspecified. Defaults to MARKDOWN.
-            FORMAT_UNSPECIFIED = 0
-
-            # The text contains Markdown formatting.
-            MARKDOWN = 1
-
-            # The text contains no special formatting.
-            RAW = 2
-          end
-        end
-      end
-    end
-  end
-end