google-cloud-monitoring-dashboard-v1 0.2.4 → 0.6.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +5 -5
- data/LICENSE.md +188 -190
- data/README.md +67 -3
- data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/client.rb +31 -25
- data/lib/google/cloud/monitoring/dashboard/v1/dashboards_service/paths.rb +17 -0
- data/lib/google/cloud/monitoring/dashboard/v1/version.rb +1 -1
- data/lib/google/monitoring/dashboard/v1/alertchart_pb.rb +26 -0
- data/lib/google/monitoring/dashboard/v1/dashboard_pb.rb +1 -0
- data/lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb +2 -0
- data/lib/google/monitoring/dashboard/v1/dashboards_service_services_pb.rb +6 -9
- data/lib/google/monitoring/dashboard/v1/layouts_pb.rb +13 -0
- data/lib/google/monitoring/dashboard/v1/scorecard_pb.rb +1 -0
- data/lib/google/monitoring/dashboard/v1/widget_pb.rb +2 -0
- data/proto_docs/google/api/distribution.rb +2 -2
- data/proto_docs/google/api/field_behavior.rb +12 -0
- data/proto_docs/google/monitoring/dashboard/v1/alertchart.rb +39 -0
- data/proto_docs/google/monitoring/dashboard/v1/common.rb +2 -0
- data/proto_docs/google/monitoring/dashboard/v1/dashboard.rb +4 -0
- data/proto_docs/google/monitoring/dashboard/v1/dashboards_service.rb +8 -0
- data/proto_docs/google/monitoring/dashboard/v1/layouts.rb +42 -0
- data/proto_docs/google/monitoring/dashboard/v1/widget.rb +3 -0
- data/proto_docs/google/protobuf/any.rb +5 -2
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- metadata +22 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d1e84026fed9b96aedb4cf0d2a21db97d825a509242c9f583e7fa79ab2aedae5
|
|
4
|
+
data.tar.gz: 64610b3b48ee8ee413c58be2b17223a9acaa8a4e05341742453604b6bf07c2a7
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d4e752e28822a931d6bafabe58e65344693432891cc10147b855bc4220bffdd17f9e4a1d9e86a846e60277f8e06e900730771f629091581aca41ada3ba82516f
|
|
7
|
+
data.tar.gz: fae261f038d4732da68a1428884340e1f782c89e85c76e80cd793f8749ea2534a00a7e440f94a98e9671e3587241ab32e46f5c85bc495dc4af4c65d3e04abfdc
|
data/AUTHENTICATION.md
CHANGED
|
@@ -66,11 +66,11 @@ The environment variables that google-cloud-monitoring-dashboard-v1
|
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
|
67
67
|
{::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Credentials}):
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
* `MONITORING_DASHBOARD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
|
+
* `MONITORING_DASHBOARD_KEYFILE` - Path to JSON file, or JSON contents
|
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
74
74
|
|
|
75
75
|
```ruby
|
|
76
76
|
require "google/cloud/monitoring/dashboard/v1"
|
data/LICENSE.md
CHANGED
|
@@ -1,192 +1,190 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
same "printed page" as the copyright notice for easier
|
|
189
|
-
identification within third-party archives.
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
190
188
|
|
|
191
189
|
Copyright [yyyy] [name of copyright owner]
|
|
192
190
|
|
|
@@ -194,7 +192,7 @@ identification within third-party archives.
|
|
|
194
192
|
you may not use this file except in compliance with the License.
|
|
195
193
|
You may obtain a copy of the License at
|
|
196
194
|
|
|
197
|
-
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
196
|
|
|
199
197
|
Unless required by applicable law or agreed to in writing, software
|
|
200
198
|
distributed under the License is distributed on an "AS IS" BASIS,
|
data/README.md
CHANGED
|
@@ -6,6 +6,12 @@ Cloud Monitoring collects metrics, events, and metadata from Google Cloud, Amazo
|
|
|
6
6
|
|
|
7
7
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
8
|
|
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
|
10
|
+
specific version of the Cloud Monitoring Dashboards V1 API. Most users should consider using
|
|
11
|
+
the main client gem,
|
|
12
|
+
[google-cloud-monitoring-dashboard](https://rubygems.org/gems/google-cloud-monitoring-dashboard).
|
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
|
14
|
+
|
|
9
15
|
## Installation
|
|
10
16
|
|
|
11
17
|
```
|
|
@@ -27,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
|
27
33
|
require "google/cloud/monitoring/dashboard/v1"
|
|
28
34
|
|
|
29
35
|
client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.new
|
|
30
|
-
request =
|
|
36
|
+
request = ::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest.new # (request fields as keyword arguments...)
|
|
31
37
|
response = client.create_dashboard request
|
|
32
38
|
```
|
|
33
39
|
|
|
@@ -65,11 +71,69 @@ end
|
|
|
65
71
|
|
|
66
72
|
## Supported Ruby Versions
|
|
67
73
|
|
|
68
|
-
This library is supported on Ruby 2.
|
|
74
|
+
This library is supported on Ruby 2.5+.
|
|
69
75
|
|
|
70
76
|
Google provides official support for Ruby versions that are actively supported
|
|
71
77
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
72
|
-
in security maintenance, and not end of life. Currently, this means Ruby 2.
|
|
78
|
+
in security maintenance, and not end of life. Currently, this means Ruby 2.5
|
|
73
79
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
74
80
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
75
81
|
about the Ruby support schedule.
|
|
82
|
+
|
|
83
|
+
## Which client should I use?
|
|
84
|
+
|
|
85
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
86
|
+
client library with a name such as `google-cloud-monitoring-dashboard`,
|
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
|
88
|
+
`google-cloud-monitoring-dashboard-v1`.
|
|
89
|
+
_In most cases, you should install the main client._
|
|
90
|
+
|
|
91
|
+
### What's the difference between the main client and a versioned client?
|
|
92
|
+
|
|
93
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
94
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
95
|
+
versions, there might be a separate versioned client for each service version.)
|
|
96
|
+
Most versioned clients are written and maintained by a code generator.
|
|
97
|
+
|
|
98
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
99
|
+
interfaces for the service. There will be only one main client for any given
|
|
100
|
+
service, even a service with multiple versions. The main client includes
|
|
101
|
+
factory methods for constructing the client objects we recommend for most
|
|
102
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
103
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
104
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
105
|
+
Generally, the main client will default to a recommended service version,
|
|
106
|
+
although in some cases you can override this if you need to talk to a specific
|
|
107
|
+
service version.
|
|
108
|
+
|
|
109
|
+
### Why would I want to use the main client?
|
|
110
|
+
|
|
111
|
+
We recommend that most users install the main client gem for a service. You can
|
|
112
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
113
|
+
`google-cloud-monitoring-dashboard`.
|
|
114
|
+
The main client is recommended because it will embody the best practices for
|
|
115
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
116
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
117
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
118
|
+
the main client.
|
|
119
|
+
|
|
120
|
+
### Why would I want to use a versioned client?
|
|
121
|
+
|
|
122
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
123
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
124
|
+
client, or you want to access a specific service version not be covered by the
|
|
125
|
+
main client. You can identify versioned client gems because the service version
|
|
126
|
+
is part of the name, e.g. `google-cloud-monitoring-dashboard-v1`.
|
|
127
|
+
|
|
128
|
+
### What about the google-apis-<name> clients?
|
|
129
|
+
|
|
130
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
131
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
132
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
133
|
+
not offer the same performance, features, and ease of use provided by more
|
|
134
|
+
modern clients.
|
|
135
|
+
|
|
136
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
137
|
+
might need to use one if there is no modern client available for the service.
|
|
138
|
+
However, if a modern client is available, we generally recommend it over the
|
|
139
|
+
older `google-apis-` clients.
|
|
@@ -62,17 +62,14 @@ module Google
|
|
|
62
62
|
parent_config = while namespace.any?
|
|
63
63
|
parent_name = namespace.join "::"
|
|
64
64
|
parent_const = const_get parent_name
|
|
65
|
-
break parent_const.configure if parent_const
|
|
65
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
66
66
|
namespace.pop
|
|
67
67
|
end
|
|
68
68
|
default_config = Client::Configuration.new parent_config
|
|
69
69
|
|
|
70
70
|
default_config.timeout = 30.0
|
|
71
71
|
default_config.retry_policy = {
|
|
72
|
-
initial_delay: 1.0,
|
|
73
|
-
max_delay: 10.0,
|
|
74
|
-
multiplier: 1.3,
|
|
75
|
-
retry_codes: [14, 2]
|
|
72
|
+
initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14, 2]
|
|
76
73
|
}
|
|
77
74
|
|
|
78
75
|
default_config.rpcs.create_dashboard.timeout = 30.0
|
|
@@ -142,8 +139,14 @@ module Google
|
|
|
142
139
|
|
|
143
140
|
# Create credentials
|
|
144
141
|
credentials = @config.credentials
|
|
145
|
-
|
|
146
|
-
if
|
|
142
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
143
|
+
# but only if the default endpoint does not have a region prefix.
|
|
144
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
145
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
146
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
147
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
148
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
149
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
147
150
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
148
151
|
end
|
|
149
152
|
@quota_project_id = @config.quota_project
|
|
@@ -161,11 +164,8 @@ module Google
|
|
|
161
164
|
# Service calls
|
|
162
165
|
|
|
163
166
|
##
|
|
164
|
-
# Creates a new custom dashboard.
|
|
165
|
-
#
|
|
166
|
-
# This method requires the `monitoring.dashboards.create` permission
|
|
167
|
-
# on the specified project. For more information, see
|
|
168
|
-
# [Google Cloud IAM](https://cloud.google.com/iam).
|
|
167
|
+
# 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).
|
|
168
|
+
# This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](/iam).
|
|
169
169
|
#
|
|
170
170
|
# @overload create_dashboard(request, options = nil)
|
|
171
171
|
# Pass arguments to `create_dashboard` via a request object, either of type
|
|
@@ -177,7 +177,7 @@ module Google
|
|
|
177
177
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
178
178
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
179
179
|
#
|
|
180
|
-
# @overload create_dashboard(parent: nil, dashboard: nil)
|
|
180
|
+
# @overload create_dashboard(parent: nil, dashboard: nil, validate_only: nil)
|
|
181
181
|
# Pass arguments to `create_dashboard` via keyword arguments. Note that at
|
|
182
182
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
183
183
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
@@ -190,6 +190,9 @@ module Google
|
|
|
190
190
|
# The `[PROJECT_ID_OR_NUMBER]` must match the dashboard resource name.
|
|
191
191
|
# @param dashboard [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash]
|
|
192
192
|
# Required. The initial dashboard specification.
|
|
193
|
+
# @param validate_only [::Boolean]
|
|
194
|
+
# If set, validate the request and preview the review, but do not actually
|
|
195
|
+
# save it.
|
|
193
196
|
#
|
|
194
197
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
195
198
|
# @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
|
|
@@ -241,7 +244,7 @@ module Google
|
|
|
241
244
|
#
|
|
242
245
|
# This method requires the `monitoring.dashboards.list` permission
|
|
243
246
|
# on the specified project. For more information, see
|
|
244
|
-
# [
|
|
247
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
245
248
|
#
|
|
246
249
|
# @overload list_dashboards(request, options = nil)
|
|
247
250
|
# Pass arguments to `list_dashboards` via a request object, either of type
|
|
@@ -321,7 +324,7 @@ module Google
|
|
|
321
324
|
#
|
|
322
325
|
# This method requires the `monitoring.dashboards.get` permission
|
|
323
326
|
# on the specified dashboard. For more information, see
|
|
324
|
-
# [
|
|
327
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
325
328
|
#
|
|
326
329
|
# @overload get_dashboard(request, options = nil)
|
|
327
330
|
# Pass arguments to `get_dashboard` via a request object, either of type
|
|
@@ -395,7 +398,7 @@ module Google
|
|
|
395
398
|
#
|
|
396
399
|
# This method requires the `monitoring.dashboards.delete` permission
|
|
397
400
|
# on the specified dashboard. For more information, see
|
|
398
|
-
# [
|
|
401
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
399
402
|
#
|
|
400
403
|
# @overload delete_dashboard(request, options = nil)
|
|
401
404
|
# Pass arguments to `delete_dashboard` via a request object, either of type
|
|
@@ -467,7 +470,7 @@ module Google
|
|
|
467
470
|
#
|
|
468
471
|
# This method requires the `monitoring.dashboards.update` permission
|
|
469
472
|
# on the specified dashboard. For more information, see
|
|
470
|
-
# [
|
|
473
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
471
474
|
#
|
|
472
475
|
# @overload update_dashboard(request, options = nil)
|
|
473
476
|
# Pass arguments to `update_dashboard` via a request object, either of type
|
|
@@ -479,13 +482,16 @@ module Google
|
|
|
479
482
|
# @param options [::Gapic::CallOptions, ::Hash]
|
|
480
483
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
|
481
484
|
#
|
|
482
|
-
# @overload update_dashboard(dashboard: nil)
|
|
485
|
+
# @overload update_dashboard(dashboard: nil, validate_only: nil)
|
|
483
486
|
# Pass arguments to `update_dashboard` via keyword arguments. Note that at
|
|
484
487
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
|
485
488
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
|
486
489
|
#
|
|
487
490
|
# @param dashboard [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard, ::Hash]
|
|
488
491
|
# Required. The dashboard that will replace the existing dashboard.
|
|
492
|
+
# @param validate_only [::Boolean]
|
|
493
|
+
# If set, validate the request and preview the review, but do not actually
|
|
494
|
+
# save it.
|
|
489
495
|
#
|
|
490
496
|
# @yield [response, operation] Access the result along with the RPC operation
|
|
491
497
|
# @yieldparam response [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
|
|
@@ -624,7 +630,7 @@ module Google
|
|
|
624
630
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
625
631
|
config_attr :lib_name, nil, ::String, nil
|
|
626
632
|
config_attr :lib_version, nil, ::String, nil
|
|
627
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
633
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
628
634
|
config_attr :interceptors, nil, ::Array, nil
|
|
629
635
|
config_attr :timeout, nil, ::Numeric, nil
|
|
630
636
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -645,7 +651,7 @@ module Google
|
|
|
645
651
|
def rpcs
|
|
646
652
|
@rpcs ||= begin
|
|
647
653
|
parent_rpcs = nil
|
|
648
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
654
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
649
655
|
Rpcs.new parent_rpcs
|
|
650
656
|
end
|
|
651
657
|
end
|
|
@@ -696,15 +702,15 @@ module Google
|
|
|
696
702
|
|
|
697
703
|
# @private
|
|
698
704
|
def initialize parent_rpcs = nil
|
|
699
|
-
create_dashboard_config = parent_rpcs
|
|
705
|
+
create_dashboard_config = parent_rpcs.create_dashboard if parent_rpcs.respond_to? :create_dashboard
|
|
700
706
|
@create_dashboard = ::Gapic::Config::Method.new create_dashboard_config
|
|
701
|
-
list_dashboards_config = parent_rpcs
|
|
707
|
+
list_dashboards_config = parent_rpcs.list_dashboards if parent_rpcs.respond_to? :list_dashboards
|
|
702
708
|
@list_dashboards = ::Gapic::Config::Method.new list_dashboards_config
|
|
703
|
-
get_dashboard_config = parent_rpcs
|
|
709
|
+
get_dashboard_config = parent_rpcs.get_dashboard if parent_rpcs.respond_to? :get_dashboard
|
|
704
710
|
@get_dashboard = ::Gapic::Config::Method.new get_dashboard_config
|
|
705
|
-
delete_dashboard_config = parent_rpcs
|
|
711
|
+
delete_dashboard_config = parent_rpcs.delete_dashboard if parent_rpcs.respond_to? :delete_dashboard
|
|
706
712
|
@delete_dashboard = ::Gapic::Config::Method.new delete_dashboard_config
|
|
707
|
-
update_dashboard_config = parent_rpcs
|
|
713
|
+
update_dashboard_config = parent_rpcs.update_dashboard if parent_rpcs.respond_to? :update_dashboard
|
|
708
714
|
@update_dashboard = ::Gapic::Config::Method.new update_dashboard_config
|
|
709
715
|
|
|
710
716
|
yield self if block_given?
|
|
@@ -25,6 +25,23 @@ module Google
|
|
|
25
25
|
module DashboardsService
|
|
26
26
|
# Path helper methods for the DashboardsService API.
|
|
27
27
|
module Paths
|
|
28
|
+
##
|
|
29
|
+
# Create a fully-qualified AlertPolicy resource string.
|
|
30
|
+
#
|
|
31
|
+
# The resource will be in the following format:
|
|
32
|
+
#
|
|
33
|
+
# `projects/{project}/alertPolicies/{alert_policy}`
|
|
34
|
+
#
|
|
35
|
+
# @param project [String]
|
|
36
|
+
# @param alert_policy [String]
|
|
37
|
+
#
|
|
38
|
+
# @return [::String]
|
|
39
|
+
def alert_policy_path project:, alert_policy:
|
|
40
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
|
41
|
+
|
|
42
|
+
"projects/#{project}/alertPolicies/#{alert_policy}"
|
|
43
|
+
end
|
|
44
|
+
|
|
28
45
|
##
|
|
29
46
|
# Create a fully-qualified Dashboard resource string.
|
|
30
47
|
#
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
|
2
|
+
# source: google/monitoring/dashboard/v1/alertchart.proto
|
|
3
|
+
|
|
4
|
+
require 'google/protobuf'
|
|
5
|
+
|
|
6
|
+
require 'google/api/field_behavior_pb'
|
|
7
|
+
require 'google/api/resource_pb'
|
|
8
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
9
|
+
add_file("google/monitoring/dashboard/v1/alertchart.proto", :syntax => :proto3) do
|
|
10
|
+
add_message "google.monitoring.dashboard.v1.AlertChart" do
|
|
11
|
+
optional :name, :string, 1
|
|
12
|
+
end
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
module Google
|
|
17
|
+
module Cloud
|
|
18
|
+
module Monitoring
|
|
19
|
+
module Dashboard
|
|
20
|
+
module V1
|
|
21
|
+
AlertChart = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.AlertChart").msgclass
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -14,6 +14,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
14
14
|
optional :etag, :string, 4
|
|
15
15
|
oneof :layout do
|
|
16
16
|
optional :grid_layout, :message, 5, "google.monitoring.dashboard.v1.GridLayout"
|
|
17
|
+
optional :mosaic_layout, :message, 6, "google.monitoring.dashboard.v1.MosaicLayout"
|
|
17
18
|
optional :row_layout, :message, 8, "google.monitoring.dashboard.v1.RowLayout"
|
|
18
19
|
optional :column_layout, :message, 9, "google.monitoring.dashboard.v1.ColumnLayout"
|
|
19
20
|
end
|
|
@@ -15,6 +15,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
15
15
|
add_message "google.monitoring.dashboard.v1.CreateDashboardRequest" do
|
|
16
16
|
optional :parent, :string, 1
|
|
17
17
|
optional :dashboard, :message, 2, "google.monitoring.dashboard.v1.Dashboard"
|
|
18
|
+
optional :validate_only, :bool, 3
|
|
18
19
|
end
|
|
19
20
|
add_message "google.monitoring.dashboard.v1.ListDashboardsRequest" do
|
|
20
21
|
optional :parent, :string, 1
|
|
@@ -33,6 +34,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
33
34
|
end
|
|
34
35
|
add_message "google.monitoring.dashboard.v1.UpdateDashboardRequest" do
|
|
35
36
|
optional :dashboard, :message, 1, "google.monitoring.dashboard.v1.Dashboard"
|
|
37
|
+
optional :validate_only, :bool, 3
|
|
36
38
|
end
|
|
37
39
|
end
|
|
38
40
|
end
|
|
@@ -35,35 +35,32 @@ module Google
|
|
|
35
35
|
self.unmarshal_class_method = :decode
|
|
36
36
|
self.service_name = 'google.monitoring.dashboard.v1.DashboardsService'
|
|
37
37
|
|
|
38
|
-
# Creates a new custom dashboard.
|
|
39
|
-
#
|
|
40
|
-
# This method requires the `monitoring.dashboards.create` permission
|
|
41
|
-
# on the specified project. For more information, see
|
|
42
|
-
# [Google Cloud IAM](https://cloud.google.com/iam).
|
|
38
|
+
# 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).
|
|
39
|
+
# This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](/iam).
|
|
43
40
|
rpc :CreateDashboard, ::Google::Cloud::Monitoring::Dashboard::V1::CreateDashboardRequest, ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
|
|
44
41
|
# Lists the existing dashboards.
|
|
45
42
|
#
|
|
46
43
|
# This method requires the `monitoring.dashboards.list` permission
|
|
47
44
|
# on the specified project. For more information, see
|
|
48
|
-
# [
|
|
45
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
49
46
|
rpc :ListDashboards, ::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsRequest, ::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsResponse
|
|
50
47
|
# Fetches a specific dashboard.
|
|
51
48
|
#
|
|
52
49
|
# This method requires the `monitoring.dashboards.get` permission
|
|
53
50
|
# on the specified dashboard. For more information, see
|
|
54
|
-
# [
|
|
51
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
55
52
|
rpc :GetDashboard, ::Google::Cloud::Monitoring::Dashboard::V1::GetDashboardRequest, ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
|
|
56
53
|
# Deletes an existing custom dashboard.
|
|
57
54
|
#
|
|
58
55
|
# This method requires the `monitoring.dashboards.delete` permission
|
|
59
56
|
# on the specified dashboard. For more information, see
|
|
60
|
-
# [
|
|
57
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
61
58
|
rpc :DeleteDashboard, ::Google::Cloud::Monitoring::Dashboard::V1::DeleteDashboardRequest, ::Google::Protobuf::Empty
|
|
62
59
|
# Replaces an existing custom dashboard with a new definition.
|
|
63
60
|
#
|
|
64
61
|
# This method requires the `monitoring.dashboards.update` permission
|
|
65
62
|
# on the specified dashboard. For more information, see
|
|
66
|
-
# [
|
|
63
|
+
# [Cloud Identity and Access Management](https://cloud.google.com/iam).
|
|
67
64
|
rpc :UpdateDashboard, ::Google::Cloud::Monitoring::Dashboard::V1::UpdateDashboardRequest, ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard
|
|
68
65
|
end
|
|
69
66
|
|
|
@@ -10,6 +10,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
10
10
|
optional :columns, :int64, 1
|
|
11
11
|
repeated :widgets, :message, 2, "google.monitoring.dashboard.v1.Widget"
|
|
12
12
|
end
|
|
13
|
+
add_message "google.monitoring.dashboard.v1.MosaicLayout" do
|
|
14
|
+
optional :columns, :int32, 1
|
|
15
|
+
repeated :tiles, :message, 3, "google.monitoring.dashboard.v1.MosaicLayout.Tile"
|
|
16
|
+
end
|
|
17
|
+
add_message "google.monitoring.dashboard.v1.MosaicLayout.Tile" do
|
|
18
|
+
optional :x_pos, :int32, 1
|
|
19
|
+
optional :y_pos, :int32, 2
|
|
20
|
+
optional :width, :int32, 3
|
|
21
|
+
optional :height, :int32, 4
|
|
22
|
+
optional :widget, :message, 5, "google.monitoring.dashboard.v1.Widget"
|
|
23
|
+
end
|
|
13
24
|
add_message "google.monitoring.dashboard.v1.RowLayout" do
|
|
14
25
|
repeated :rows, :message, 1, "google.monitoring.dashboard.v1.RowLayout.Row"
|
|
15
26
|
end
|
|
@@ -33,6 +44,8 @@ module Google
|
|
|
33
44
|
module Dashboard
|
|
34
45
|
module V1
|
|
35
46
|
GridLayout = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.GridLayout").msgclass
|
|
47
|
+
MosaicLayout = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.MosaicLayout").msgclass
|
|
48
|
+
MosaicLayout::Tile = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.MosaicLayout.Tile").msgclass
|
|
36
49
|
RowLayout = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.RowLayout").msgclass
|
|
37
50
|
RowLayout::Row = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.RowLayout.Row").msgclass
|
|
38
51
|
ColumnLayout = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.monitoring.dashboard.v1.ColumnLayout").msgclass
|
|
@@ -6,6 +6,7 @@ require 'google/protobuf'
|
|
|
6
6
|
require 'google/api/field_behavior_pb'
|
|
7
7
|
require 'google/monitoring/dashboard/v1/metrics_pb'
|
|
8
8
|
require 'google/protobuf/duration_pb'
|
|
9
|
+
require 'google/protobuf/empty_pb'
|
|
9
10
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
10
11
|
add_file("google/monitoring/dashboard/v1/scorecard.proto", :syntax => :proto3) do
|
|
11
12
|
add_message "google.monitoring.dashboard.v1.Scorecard" do
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
require 'google/protobuf'
|
|
5
5
|
|
|
6
6
|
require 'google/api/field_behavior_pb'
|
|
7
|
+
require 'google/monitoring/dashboard/v1/alertchart_pb'
|
|
7
8
|
require 'google/monitoring/dashboard/v1/scorecard_pb'
|
|
8
9
|
require 'google/monitoring/dashboard/v1/text_pb'
|
|
9
10
|
require 'google/monitoring/dashboard/v1/xychart_pb'
|
|
@@ -17,6 +18,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
|
17
18
|
optional :scorecard, :message, 3, "google.monitoring.dashboard.v1.Scorecard"
|
|
18
19
|
optional :text, :message, 4, "google.monitoring.dashboard.v1.Text"
|
|
19
20
|
optional :blank, :message, 5, "google.protobuf.Empty"
|
|
21
|
+
optional :alert_chart, :message, 7, "google.monitoring.dashboard.v1.AlertChart"
|
|
20
22
|
end
|
|
21
23
|
end
|
|
22
24
|
end
|
|
@@ -49,7 +49,7 @@ module Google
|
|
|
49
49
|
#
|
|
50
50
|
# Sum[i=1..n]((x_i - mean)^2)
|
|
51
51
|
#
|
|
52
|
-
# Knuth, "The Art of Computer Programming", Vol. 2, page
|
|
52
|
+
# Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition
|
|
53
53
|
# describes Welford's method for accumulating this sum in one pass.
|
|
54
54
|
#
|
|
55
55
|
# If `count` is zero then this field must be zero.
|
|
@@ -207,7 +207,7 @@ module Google
|
|
|
207
207
|
# @return [::Array<::Google::Protobuf::Any>]
|
|
208
208
|
# Contextual information about the example value. Examples are:
|
|
209
209
|
#
|
|
210
|
-
# Trace
|
|
210
|
+
# Trace: type.googleapis.com/google.monitoring.v3.SpanContext
|
|
211
211
|
#
|
|
212
212
|
# Literal string: type.googleapis.com/google.protobuf.StringValue
|
|
213
213
|
#
|
|
@@ -54,6 +54,18 @@ module Google
|
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
|
55
55
|
# resource, but may not be changed thereafter.
|
|
56
56
|
IMMUTABLE = 5
|
|
57
|
+
|
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
|
59
|
+
# This indicates that the service may provide the elements of the list
|
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
|
62
|
+
UNORDERED_LIST = 6
|
|
63
|
+
|
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
|
67
|
+
# non-empty value to expect.
|
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
|
57
69
|
end
|
|
58
70
|
end
|
|
59
71
|
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Copyright 2021 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
|
+
# A chart that displays alert policy data.
|
|
26
|
+
# @!attribute [rw] name
|
|
27
|
+
# @return [::String]
|
|
28
|
+
# Required. The resource name of the alert policy. The format is:
|
|
29
|
+
#
|
|
30
|
+
# projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
|
|
31
|
+
class AlertChart
|
|
32
|
+
include ::Google::Protobuf::MessageExts
|
|
33
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -60,6 +60,8 @@ module Google
|
|
|
60
60
|
# `ALIGN_NONE` is specified, this field is required or an error is returned.
|
|
61
61
|
# If no per-series aligner is specified, or the aligner `ALIGN_NONE` is
|
|
62
62
|
# specified, then this field is ignored.
|
|
63
|
+
#
|
|
64
|
+
# The maximum value of the `alignment_period` is 2 years, or 104 weeks.
|
|
63
65
|
# @!attribute [rw] per_series_aligner
|
|
64
66
|
# @return [::Google::Cloud::Monitoring::Dashboard::V1::Aggregation::Aligner]
|
|
65
67
|
# An `Aligner` describes how to bring the data points in a single
|
|
@@ -43,6 +43,10 @@ module Google
|
|
|
43
43
|
# @return [::Google::Cloud::Monitoring::Dashboard::V1::GridLayout]
|
|
44
44
|
# Content is arranged with a basic layout that re-flows a simple list of
|
|
45
45
|
# informational elements like widgets or tiles.
|
|
46
|
+
# @!attribute [rw] mosaic_layout
|
|
47
|
+
# @return [::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout]
|
|
48
|
+
# The content is arranged as a grid of tiles, with each content widget
|
|
49
|
+
# occupying one or more grid blocks.
|
|
46
50
|
# @!attribute [rw] row_layout
|
|
47
51
|
# @return [::Google::Cloud::Monitoring::Dashboard::V1::RowLayout]
|
|
48
52
|
# The content is divided into equally spaced rows and the widgets are
|
|
@@ -33,6 +33,10 @@ module Google
|
|
|
33
33
|
# @!attribute [rw] dashboard
|
|
34
34
|
# @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
|
|
35
35
|
# Required. The initial dashboard specification.
|
|
36
|
+
# @!attribute [rw] validate_only
|
|
37
|
+
# @return [::Boolean]
|
|
38
|
+
# If set, validate the request and preview the review, but do not actually
|
|
39
|
+
# save it.
|
|
36
40
|
class CreateDashboardRequest
|
|
37
41
|
include ::Google::Protobuf::MessageExts
|
|
38
42
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -100,6 +104,10 @@ module Google
|
|
|
100
104
|
# @!attribute [rw] dashboard
|
|
101
105
|
# @return [::Google::Cloud::Monitoring::Dashboard::V1::Dashboard]
|
|
102
106
|
# Required. The dashboard that will replace the existing dashboard.
|
|
107
|
+
# @!attribute [rw] validate_only
|
|
108
|
+
# @return [::Boolean]
|
|
109
|
+
# If set, validate the request and preview the review, but do not actually
|
|
110
|
+
# save it.
|
|
103
111
|
class UpdateDashboardRequest
|
|
104
112
|
include ::Google::Protobuf::MessageExts
|
|
105
113
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -36,6 +36,48 @@ module Google
|
|
|
36
36
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
37
37
|
end
|
|
38
38
|
|
|
39
|
+
# A mosaic layout divides the available space into a grid of blocks, and
|
|
40
|
+
# overlays the grid with tiles. Unlike `GridLayout`, tiles may span multiple
|
|
41
|
+
# grid blocks and can be placed at arbitrary locations in the grid.
|
|
42
|
+
# @!attribute [rw] columns
|
|
43
|
+
# @return [::Integer]
|
|
44
|
+
# The number of columns in the mosaic grid. The number of columns must be
|
|
45
|
+
# between 1 and 12, inclusive.
|
|
46
|
+
# @!attribute [rw] tiles
|
|
47
|
+
# @return [::Array<::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout::Tile>]
|
|
48
|
+
# The tiles to display.
|
|
49
|
+
class MosaicLayout
|
|
50
|
+
include ::Google::Protobuf::MessageExts
|
|
51
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
52
|
+
|
|
53
|
+
# A single tile in the mosaic. The placement and size of the tile are
|
|
54
|
+
# configurable.
|
|
55
|
+
# @!attribute [rw] x_pos
|
|
56
|
+
# @return [::Integer]
|
|
57
|
+
# The zero-indexed position of the tile in grid blocks relative to the
|
|
58
|
+
# left edge of the grid. Tiles must be contained within the specified
|
|
59
|
+
# number of columns. `x_pos` cannot be negative.
|
|
60
|
+
# @!attribute [rw] y_pos
|
|
61
|
+
# @return [::Integer]
|
|
62
|
+
# The zero-indexed position of the tile in grid blocks relative to the
|
|
63
|
+
# top edge of the grid. `y_pos` cannot be negative.
|
|
64
|
+
# @!attribute [rw] width
|
|
65
|
+
# @return [::Integer]
|
|
66
|
+
# The width of the tile, measured in grid blocks. Tiles must have a
|
|
67
|
+
# minimum width of 1.
|
|
68
|
+
# @!attribute [rw] height
|
|
69
|
+
# @return [::Integer]
|
|
70
|
+
# The height of the tile, measured in grid blocks. Tiles must have a
|
|
71
|
+
# minimum height of 1.
|
|
72
|
+
# @!attribute [rw] widget
|
|
73
|
+
# @return [::Google::Cloud::Monitoring::Dashboard::V1::Widget]
|
|
74
|
+
# The informational widget contained in the tile. For example an `XyChart`.
|
|
75
|
+
class Tile
|
|
76
|
+
include ::Google::Protobuf::MessageExts
|
|
77
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
|
|
39
81
|
# A simplified layout that divides the available space into rows
|
|
40
82
|
# and arranges a set of widgets horizontally in each row.
|
|
41
83
|
# @!attribute [rw] rows
|
|
@@ -39,6 +39,9 @@ module Google
|
|
|
39
39
|
# @!attribute [rw] blank
|
|
40
40
|
# @return [::Google::Protobuf::Empty]
|
|
41
41
|
# A blank space.
|
|
42
|
+
# @!attribute [rw] alert_chart
|
|
43
|
+
# @return [::Google::Cloud::Monitoring::Dashboard::V1::AlertChart]
|
|
44
|
+
# A chart of alert policy data.
|
|
42
45
|
class Widget
|
|
43
46
|
include ::Google::Protobuf::MessageExts
|
|
44
47
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
|
@@ -57,10 +57,13 @@ module Google
|
|
|
57
57
|
# Example 4: Pack and unpack a message in Go
|
|
58
58
|
#
|
|
59
59
|
# foo := &pb.Foo{...}
|
|
60
|
-
# any, err :=
|
|
60
|
+
# any, err := anypb.New(foo)
|
|
61
|
+
# if err != nil {
|
|
62
|
+
# ...
|
|
63
|
+
# }
|
|
61
64
|
# ...
|
|
62
65
|
# foo := &pb.Foo{}
|
|
63
|
-
# if err :=
|
|
66
|
+
# if err := any.UnmarshalTo(foo); err != nil {
|
|
64
67
|
# ...
|
|
65
68
|
# }
|
|
66
69
|
#
|
|
@@ -70,7 +70,16 @@ module Google
|
|
|
70
70
|
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
|
71
71
|
#
|
|
72
72
|
#
|
|
73
|
-
# Example 5: Compute Timestamp from
|
|
73
|
+
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
|
74
|
+
#
|
|
75
|
+
# Instant now = Instant.now();
|
|
76
|
+
#
|
|
77
|
+
# Timestamp timestamp =
|
|
78
|
+
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
|
79
|
+
# .setNanos(now.getNano()).build();
|
|
80
|
+
#
|
|
81
|
+
#
|
|
82
|
+
# Example 6: Compute Timestamp from current time in Python.
|
|
74
83
|
#
|
|
75
84
|
# timestamp = Timestamp()
|
|
76
85
|
# timestamp.GetCurrentTime()
|
metadata
CHANGED
|
@@ -1,29 +1,35 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-monitoring-dashboard-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.6.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Google LLC
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-07-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
|
-
- - "
|
|
17
|
+
- - ">="
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0.5'
|
|
20
|
+
- - "<"
|
|
18
21
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
22
|
+
version: 2.a
|
|
20
23
|
type: :runtime
|
|
21
24
|
prerelease: false
|
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
26
|
requirements:
|
|
24
|
-
- - "
|
|
27
|
+
- - ">="
|
|
28
|
+
- !ruby/object:Gem::Version
|
|
29
|
+
version: '0.5'
|
|
30
|
+
- - "<"
|
|
25
31
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
32
|
+
version: 2.a
|
|
27
33
|
- !ruby/object:Gem::Dependency
|
|
28
34
|
name: google-cloud-errors
|
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -44,14 +50,14 @@ dependencies:
|
|
|
44
50
|
requirements:
|
|
45
51
|
- - "~>"
|
|
46
52
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: 1.
|
|
53
|
+
version: 1.25.1
|
|
48
54
|
type: :development
|
|
49
55
|
prerelease: false
|
|
50
56
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
57
|
requirements:
|
|
52
58
|
- - "~>"
|
|
53
59
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: 1.
|
|
60
|
+
version: 1.25.1
|
|
55
61
|
- !ruby/object:Gem::Dependency
|
|
56
62
|
name: minitest
|
|
57
63
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -152,7 +158,10 @@ dependencies:
|
|
|
152
158
|
version: '0.9'
|
|
153
159
|
description: Cloud Monitoring collects metrics, events, and metadata from Google Cloud,
|
|
154
160
|
Amazon Web Services (AWS), hosted uptime probes, and application instrumentation.
|
|
155
|
-
The Dashboards API manages arrangements of display widgets.
|
|
161
|
+
The Dashboards API manages arrangements of display widgets. Note that google-cloud-monitoring-dashboard-v1
|
|
162
|
+
is a version-specific client library. For most uses, we recommend installing the
|
|
163
|
+
main client library google-cloud-monitoring-dashboard instead. See the readme for
|
|
164
|
+
more details.
|
|
156
165
|
email: googleapis-packages@google.com
|
|
157
166
|
executables: []
|
|
158
167
|
extensions: []
|
|
@@ -169,6 +178,7 @@ files:
|
|
|
169
178
|
- lib/google/cloud/monitoring/dashboard/v1/dashboards_service/credentials.rb
|
|
170
179
|
- lib/google/cloud/monitoring/dashboard/v1/dashboards_service/paths.rb
|
|
171
180
|
- lib/google/cloud/monitoring/dashboard/v1/version.rb
|
|
181
|
+
- lib/google/monitoring/dashboard/v1/alertchart_pb.rb
|
|
172
182
|
- lib/google/monitoring/dashboard/v1/common_pb.rb
|
|
173
183
|
- lib/google/monitoring/dashboard/v1/dashboard_pb.rb
|
|
174
184
|
- lib/google/monitoring/dashboard/v1/dashboards_service_pb.rb
|
|
@@ -185,6 +195,7 @@ files:
|
|
|
185
195
|
- proto_docs/google/api/distribution.rb
|
|
186
196
|
- proto_docs/google/api/field_behavior.rb
|
|
187
197
|
- proto_docs/google/api/resource.rb
|
|
198
|
+
- proto_docs/google/monitoring/dashboard/v1/alertchart.rb
|
|
188
199
|
- proto_docs/google/monitoring/dashboard/v1/common.rb
|
|
189
200
|
- proto_docs/google/monitoring/dashboard/v1/dashboard.rb
|
|
190
201
|
- proto_docs/google/monitoring/dashboard/v1/dashboards_service.rb
|
|
@@ -211,14 +222,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
211
222
|
requirements:
|
|
212
223
|
- - ">="
|
|
213
224
|
- !ruby/object:Gem::Version
|
|
214
|
-
version: '2.
|
|
225
|
+
version: '2.5'
|
|
215
226
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
216
227
|
requirements:
|
|
217
228
|
- - ">="
|
|
218
229
|
- !ruby/object:Gem::Version
|
|
219
230
|
version: '0'
|
|
220
231
|
requirements: []
|
|
221
|
-
rubygems_version: 3.2.
|
|
232
|
+
rubygems_version: 3.2.17
|
|
222
233
|
signing_key:
|
|
223
234
|
specification_version: 4
|
|
224
235
|
summary: API Client library for the Cloud Monitoring Dashboards V1 API
|