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

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 27ffba53831c8bf280f963549d5021b3134198ac371257267c02fda590fe45c1
4
- data.tar.gz: d342c29e46bfb2c3403b10fb121f9482d3cbf36a35ea75e085f379c2e2a22194
3
+ metadata.gz: e3f4b996571db7f63c79e1b50128d6934d06121f84ea895d066c4200c21c61c0
4
+ data.tar.gz: c954e773bda129ecf11ab2f8bdcfa7afa8a8408eb004dcf8e371598ca246b87c
5
5
  SHA512:
6
- metadata.gz: 7deb879b016813cbd563d6b4d5158602c361cbd18821f64443476d70a95762f167f8e37e248e1c8985b6dc600385d9ab258d16cf628d6c3de4f63076c69427a1
7
- data.tar.gz: bfb38c855356d563af7e775be751834b9fe0b1cc5adf60b4fc79c79449fdd81a33cc6282a3d151c4d7f50715ab4c1b6a35c2904e5c5cdab0dd0df4ab97893d05
6
+ metadata.gz: 3a201e368e64dee0c2994a14236b1607da96862aa131d9bfd8fde9ed6e1fe2245e0750d7b2757ce85f7076d618538a61ae1ec3fc4fef0cf86e7cb6af0d021663
7
+ data.tar.gz: 10d33d5b5e06c8b20867c49a33f99d4a973c9d50536c07b7921fd9734c45551e0fbf1e19f6a2c6f80b244a0fd5820d7d65e7dd50e426f0763faa78a37ef24f69
@@ -23,6 +23,7 @@ require "gapic/config/method"
23
23
  require "google/cloud/monitoring/dashboard/v1/version"
24
24
 
25
25
  require "google/cloud/monitoring/dashboard/v1/dashboards_service/credentials"
26
+ require "google/cloud/monitoring/dashboard/v1/dashboards_service/paths"
26
27
  require "google/cloud/monitoring/dashboard/v1/dashboards_service/client"
27
28
 
28
29
  module Google
@@ -32,6 +32,8 @@ module Google
32
32
  # widgets in a specific layout.
33
33
  #
34
34
  class Client
35
+ include Paths
36
+
35
37
  # @private
36
38
  attr_reader :dashboards_service_stub
37
39
 
@@ -167,9 +169,11 @@ module Google
167
169
  # the default parameter values, pass an empty Hash as a request object (see above).
168
170
  #
169
171
  # @param parent [::String]
170
- # Required. The project on which to execute the request. The format is
171
- # `"projects/{project_id_or_number}"`. The \\{project_id_or_number} must match
172
- # the dashboard resource name.
172
+ # Required. The project on which to execute the request. The format is:
173
+ #
174
+ # projects/[PROJECT_ID_OR_NUMBER]
175
+ #
176
+ # The `[PROJECT_ID_OR_NUMBER]` must match the dashboard resource name.
173
177
  # @param dashboard [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash]
174
178
  # Required. The initial dashboard specification.
175
179
  #
@@ -241,8 +245,9 @@ module Google
241
245
  # the default parameter values, pass an empty Hash as a request object (see above).
242
246
  #
243
247
  # @param parent [::String]
244
- # Required. The scope of the dashboards to list. A project scope must be
245
- # specified in the form of `"projects/{project_id_or_number}"`.
248
+ # Required. The scope of the dashboards to list. The format is:
249
+ #
250
+ # projects/[PROJECT_ID_OR_NUMBER]
246
251
  # @param page_size [::Integer]
247
252
  # A positive number that is the maximum number of results to return.
248
253
  # If unspecified, a default of 1000 is used.
@@ -320,10 +325,11 @@ module Google
320
325
  # the default parameter values, pass an empty Hash as a request object (see above).
321
326
  #
322
327
  # @param name [::String]
323
- # Required. The resource name of the Dashboard. The format is one of
324
- # `"dashboards/{dashboard_id}"` (for system dashboards) or
325
- # `"projects/{project_id_or_number}/dashboards/{dashboard_id}"`
326
- # (for custom dashboards).
328
+ # Required. The resource name of the Dashboard. The format is one of:
329
+ #
330
+ # - `dashboards/[DASHBOARD_ID]` (for system dashboards)
331
+ # - `projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]`
332
+ # (for custom dashboards).
327
333
  #
328
334
  # @yield [response, operation] Access the result along with the RPC operation
329
335
  # @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
@@ -393,8 +399,9 @@ module Google
393
399
  # the default parameter values, pass an empty Hash as a request object (see above).
394
400
  #
395
401
  # @param name [::String]
396
- # Required. The resource name of the Dashboard. The format is
397
- # `"projects/{project_id_or_number}/dashboards/{dashboard_id}"`.
402
+ # Required. The resource name of the Dashboard. The format is:
403
+ #
404
+ # projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
398
405
  #
399
406
  # @yield [response, operation] Access the result along with the RPC operation
400
407
  # @yieldparam response [::Google::Protobuf::Empty]
@@ -0,0 +1,66 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Monitoring
23
+ module Dashboard
24
+ module V1
25
+ module DashboardsService
26
+ # Path helper methods for the DashboardsService API.
27
+ module Paths
28
+ ##
29
+ # Create a fully-qualified Dashboard resource string.
30
+ #
31
+ # The resource will be in the following format:
32
+ #
33
+ # `projects/{project}/dashboards/{dashboard}`
34
+ #
35
+ # @param project [String]
36
+ # @param dashboard [String]
37
+ #
38
+ # @return [::String]
39
+ def dashboard_path project:, dashboard:
40
+ raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
41
+
42
+ "projects/#{project}/dashboards/#{dashboard}"
43
+ end
44
+
45
+ ##
46
+ # Create a fully-qualified Project resource string.
47
+ #
48
+ # The resource will be in the following format:
49
+ #
50
+ # `projects/{project}`
51
+ #
52
+ # @param project [String]
53
+ #
54
+ # @return [::String]
55
+ def project_path project:
56
+ "projects/#{project}"
57
+ end
58
+
59
+ extend self
60
+ end
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
@@ -22,7 +22,7 @@ module Google
22
22
  module Monitoring
23
23
  module Dashboard
24
24
  module V1
25
- VERSION = "0.1.1"
25
+ VERSION = "0.2.0"
26
26
  end
27
27
  end
28
28
  end
@@ -3,6 +3,7 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/api/distribution_pb'
6
7
  require 'google/protobuf/duration_pb'
7
8
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
9
  add_file("google/monitoring/dashboard/v1/common.proto", :syntax => :proto3) do
@@ -3,6 +3,8 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/api/field_behavior_pb'
7
+ require 'google/api/resource_pb'
6
8
  require 'google/monitoring/dashboard/v1/layouts_pb'
7
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
8
10
  add_file("google/monitoring/dashboard/v1/dashboard.proto", :syntax => :proto3) do
@@ -5,6 +5,7 @@ require 'google/protobuf'
5
5
 
6
6
  require 'google/api/annotations_pb'
7
7
  require 'google/api/field_behavior_pb'
8
+ require 'google/api/resource_pb'
8
9
  require 'google/monitoring/dashboard/v1/dashboard_pb'
9
10
  require 'google/protobuf/empty_pb'
10
11
  require 'google/protobuf/field_mask_pb'
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/monitoring/dashboard/v1/dashboards_service.proto for package 'Google.Cloud.Monitoring.Dashboard.V1'
3
3
  # Original file comments:
4
- # Copyright 2019 Google LLC.
4
+ # Copyright 2020 Google LLC
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
15
15
  # See the License for the specific language governing permissions and
16
16
  # limitations under the License.
17
17
  #
18
- #
19
18
 
20
19
  require 'grpc'
21
20
  require 'google/monitoring/dashboard/v1/dashboards_service_pb'
@@ -3,6 +3,7 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/monitoring/dashboard/v1/common_pb'
6
7
  Google::Protobuf::DescriptorPool.generated_pool.build do
7
8
  add_file("google/monitoring/dashboard/v1/drilldowns.proto", :syntax => :proto3) do
8
9
  end
@@ -12,11 +12,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
12
12
  oneof :source do
13
13
  optional :time_series_filter, :message, 1, "google.monitoring.dashboard.v1.TimeSeriesFilter"
14
14
  optional :time_series_filter_ratio, :message, 2, "google.monitoring.dashboard.v1.TimeSeriesFilterRatio"
15
+ optional :time_series_query_language, :string, 3
15
16
  end
16
17
  end
17
18
  add_message "google.monitoring.dashboard.v1.TimeSeriesFilter" do
18
19
  optional :filter, :string, 1
19
20
  optional :aggregation, :message, 2, "google.monitoring.dashboard.v1.Aggregation"
21
+ optional :secondary_aggregation, :message, 3, "google.monitoring.dashboard.v1.Aggregation"
20
22
  oneof :output_filter do
21
23
  optional :pick_time_series_filter, :message, 4, "google.monitoring.dashboard.v1.PickTimeSeriesFilter"
22
24
  optional :statistical_time_series_filter, :message, 5, "google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter"
@@ -3,6 +3,7 @@
3
3
 
4
4
  require 'google/protobuf'
5
5
 
6
+ require 'google/api/field_behavior_pb'
6
7
  require 'google/monitoring/dashboard/v1/metrics_pb'
7
8
  require 'google/protobuf/duration_pb'
8
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -0,0 +1,225 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Api
22
+ # `Distribution` contains summary statistics for a population of values. It
23
+ # optionally contains a histogram representing the distribution of those values
24
+ # across a set of buckets.
25
+ #
26
+ # The summary statistics are the count, mean, sum of the squared deviation from
27
+ # the mean, the minimum, and the maximum of the set of population of values.
28
+ # The histogram is based on a sequence of buckets and gives a count of values
29
+ # that fall into each bucket. The boundaries of the buckets are given either
30
+ # explicitly or by formulas for buckets of fixed or exponentially increasing
31
+ # widths.
32
+ #
33
+ # Although it is not forbidden, it is generally a bad idea to include
34
+ # non-finite values (infinities or NaNs) in the population of values, as this
35
+ # will render the `mean` and `sum_of_squared_deviation` fields meaningless.
36
+ # @!attribute [rw] count
37
+ # @return [::Integer]
38
+ # The number of values in the population. Must be non-negative. This value
39
+ # must equal the sum of the values in `bucket_counts` if a histogram is
40
+ # provided.
41
+ # @!attribute [rw] mean
42
+ # @return [::Float]
43
+ # The arithmetic mean of the values in the population. If `count` is zero
44
+ # then this field must be zero.
45
+ # @!attribute [rw] sum_of_squared_deviation
46
+ # @return [::Float]
47
+ # The sum of squared deviations from the mean of the values in the
48
+ # population. For values x_i this is:
49
+ #
50
+ # Sum[i=1..n]((x_i - mean)^2)
51
+ #
52
+ # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
53
+ # describes Welford's method for accumulating this sum in one pass.
54
+ #
55
+ # If `count` is zero then this field must be zero.
56
+ # @!attribute [rw] range
57
+ # @return [::Google::Api::Distribution::Range]
58
+ # If specified, contains the range of the population values. The field
59
+ # must not be present if the `count` is zero.
60
+ # @!attribute [rw] bucket_options
61
+ # @return [::Google::Api::Distribution::BucketOptions]
62
+ # Defines the histogram bucket boundaries. If the distribution does not
63
+ # contain a histogram, then omit this field.
64
+ # @!attribute [rw] bucket_counts
65
+ # @return [::Array<::Integer>]
66
+ # The number of values in each bucket of the histogram, as described in
67
+ # `bucket_options`. If the distribution does not have a histogram, then omit
68
+ # this field. If there is a histogram, then the sum of the values in
69
+ # `bucket_counts` must equal the value in the `count` field of the
70
+ # distribution.
71
+ #
72
+ # If present, `bucket_counts` should contain N values, where N is the number
73
+ # of buckets specified in `bucket_options`. If you supply fewer than N
74
+ # values, the remaining values are assumed to be 0.
75
+ #
76
+ # The order of the values in `bucket_counts` follows the bucket numbering
77
+ # schemes described for the three bucket types. The first value must be the
78
+ # count for the underflow bucket (number 0). The next N-2 values are the
79
+ # counts for the finite buckets (number 1 through N-2). The N'th value in
80
+ # `bucket_counts` is the count for the overflow bucket (number N-1).
81
+ # @!attribute [rw] exemplars
82
+ # @return [::Array<::Google::Api::Distribution::Exemplar>]
83
+ # Must be in increasing order of `value` field.
84
+ class Distribution
85
+ include ::Google::Protobuf::MessageExts
86
+ extend ::Google::Protobuf::MessageExts::ClassMethods
87
+
88
+ # The range of the population values.
89
+ # @!attribute [rw] min
90
+ # @return [::Float]
91
+ # The minimum of the population values.
92
+ # @!attribute [rw] max
93
+ # @return [::Float]
94
+ # The maximum of the population values.
95
+ class Range
96
+ include ::Google::Protobuf::MessageExts
97
+ extend ::Google::Protobuf::MessageExts::ClassMethods
98
+ end
99
+
100
+ # `BucketOptions` describes the bucket boundaries used to create a histogram
101
+ # for the distribution. The buckets can be in a linear sequence, an
102
+ # exponential sequence, or each bucket can be specified explicitly.
103
+ # `BucketOptions` does not include the number of values in each bucket.
104
+ #
105
+ # A bucket has an inclusive lower bound and exclusive upper bound for the
106
+ # values that are counted for that bucket. The upper bound of a bucket must
107
+ # be strictly greater than the lower bound. The sequence of N buckets for a
108
+ # distribution consists of an underflow bucket (number 0), zero or more
109
+ # finite buckets (number 1 through N - 2) and an overflow bucket (number N -
110
+ # 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the
111
+ # same as the upper bound of bucket i - 1. The buckets span the whole range
112
+ # of finite values: lower bound of the underflow bucket is -infinity and the
113
+ # upper bound of the overflow bucket is +infinity. The finite buckets are
114
+ # so-called because both bounds are finite.
115
+ # @!attribute [rw] linear_buckets
116
+ # @return [::Google::Api::Distribution::BucketOptions::Linear]
117
+ # The linear bucket.
118
+ # @!attribute [rw] exponential_buckets
119
+ # @return [::Google::Api::Distribution::BucketOptions::Exponential]
120
+ # The exponential buckets.
121
+ # @!attribute [rw] explicit_buckets
122
+ # @return [::Google::Api::Distribution::BucketOptions::Explicit]
123
+ # The explicit buckets.
124
+ class BucketOptions
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+
128
+ # Specifies a linear sequence of buckets that all have the same width
129
+ # (except overflow and underflow). Each bucket represents a constant
130
+ # absolute uncertainty on the specific value in the bucket.
131
+ #
132
+ # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
133
+ # following boundaries:
134
+ #
135
+ # Upper bound (0 <= i < N-1): offset + (width * i).
136
+ # Lower bound (1 <= i < N): offset + (width * (i - 1)).
137
+ # @!attribute [rw] num_finite_buckets
138
+ # @return [::Integer]
139
+ # Must be greater than 0.
140
+ # @!attribute [rw] width
141
+ # @return [::Float]
142
+ # Must be greater than 0.
143
+ # @!attribute [rw] offset
144
+ # @return [::Float]
145
+ # Lower bound of the first bucket.
146
+ class Linear
147
+ include ::Google::Protobuf::MessageExts
148
+ extend ::Google::Protobuf::MessageExts::ClassMethods
149
+ end
150
+
151
+ # Specifies an exponential sequence of buckets that have a width that is
152
+ # proportional to the value of the lower bound. Each bucket represents a
153
+ # constant relative uncertainty on a specific value in the bucket.
154
+ #
155
+ # There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the
156
+ # following boundaries:
157
+ #
158
+ # Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
159
+ # Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
160
+ # @!attribute [rw] num_finite_buckets
161
+ # @return [::Integer]
162
+ # Must be greater than 0.
163
+ # @!attribute [rw] growth_factor
164
+ # @return [::Float]
165
+ # Must be greater than 1.
166
+ # @!attribute [rw] scale
167
+ # @return [::Float]
168
+ # Must be greater than 0.
169
+ class Exponential
170
+ include ::Google::Protobuf::MessageExts
171
+ extend ::Google::Protobuf::MessageExts::ClassMethods
172
+ end
173
+
174
+ # Specifies a set of buckets with arbitrary widths.
175
+ #
176
+ # There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following
177
+ # boundaries:
178
+ #
179
+ # Upper bound (0 <= i < N-1): bounds[i]
180
+ # Lower bound (1 <= i < N); bounds[i - 1]
181
+ #
182
+ # The `bounds` field must contain at least one element. If `bounds` has
183
+ # only one element, then there are no finite buckets, and that single
184
+ # element is the common boundary of the overflow and underflow buckets.
185
+ # @!attribute [rw] bounds
186
+ # @return [::Array<::Float>]
187
+ # The values must be monotonically increasing.
188
+ class Explicit
189
+ include ::Google::Protobuf::MessageExts
190
+ extend ::Google::Protobuf::MessageExts::ClassMethods
191
+ end
192
+ end
193
+
194
+ # Exemplars are example points that may be used to annotate aggregated
195
+ # distribution values. They are metadata that gives information about a
196
+ # particular value added to a Distribution bucket, such as a trace ID that
197
+ # was active when a value was added. They may contain further information,
198
+ # such as a example values and timestamps, origin, etc.
199
+ # @!attribute [rw] value
200
+ # @return [::Float]
201
+ # Value of the exemplar point. This value determines to which bucket the
202
+ # exemplar belongs.
203
+ # @!attribute [rw] timestamp
204
+ # @return [::Google::Protobuf::Timestamp]
205
+ # The observation (sampling) time of the above value.
206
+ # @!attribute [rw] attachments
207
+ # @return [::Array<::Google::Protobuf::Any>]
208
+ # Contextual information about the example value. Examples are:
209
+ #
210
+ # Trace ID: type.googleapis.com/google.devtools.cloudtrace.v1.Trace
211
+ #
212
+ # Literal string: type.googleapis.com/google.protobuf.StringValue
213
+ #
214
+ # Labels dropped during aggregation:
215
+ # type.googleapis.com/google.monitoring.v3.DroppedLabels
216
+ #
217
+ # There may be only a single attachment of any given message type in a
218
+ # single exemplar, and this is enforced by the system.
219
+ class Exemplar
220
+ include ::Google::Protobuf::MessageExts
221
+ extend ::Google::Protobuf::MessageExts::ClassMethods
222
+ end
223
+ end
224
+ end
225
+ end