OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 }, | 7 }, |
8 "https://www.googleapis.com/auth/monitoring": { | |
9 "description": "View and write monitoring data for all of yo
ur Google and third-party Cloud and API projects" | |
10 }, | |
11 "https://www.googleapis.com/auth/monitoring.read": { | 8 "https://www.googleapis.com/auth/monitoring.read": { |
12 "description": "View monitoring data for all of your Google
Cloud and third-party projects" | 9 "description": "View monitoring data for all of your Google
Cloud and third-party projects" |
13 }, | 10 }, |
14 "https://www.googleapis.com/auth/monitoring.write": { | 11 "https://www.googleapis.com/auth/monitoring.write": { |
15 "description": "Publish metric data to your Google Cloud pro
jects" | 12 "description": "Publish metric data to your Google Cloud pro
jects" |
| 13 }, |
| 14 "https://www.googleapis.com/auth/monitoring": { |
| 15 "description": "View and write monitoring data for all of yo
ur Google and third-party Cloud and API projects" |
16 } | 16 } |
17 } | 17 } |
18 } | 18 } |
19 }, | 19 }, |
20 "basePath": "", | 20 "basePath": "", |
21 "baseUrl": "https://monitoring.googleapis.com/", | 21 "baseUrl": "https://monitoring.googleapis.com/", |
22 "batchPath": "batch", | 22 "batchPath": "batch", |
23 "description": "Manages your Stackdriver monitoring data and configurations.
Projects must be associated with a Stackdriver account, except for the followin
g methods: [monitoredResourceDescriptors.list](v3/projects.monitoredResourceDesc
riptors/list), [monitoredResourceDescriptors.get](v3/projects.monitoredResourceD
escriptors/get), [metricDescriptors.list](v3/projects.metricDescriptors/list), [
metricDescriptors.get](v3/projects.metricDescriptors/get), and [timeSeries.list]
(v3/projects.timeSeries/list).", | 23 "canonicalName": "Monitoring", |
| 24 "description": "Manages your Stackdriver Monitoring data and configurations.
Most projects must be associated with a Stackdriver account, with a few excepti
ons as noted on the individual method pages.", |
24 "discoveryVersion": "v1", | 25 "discoveryVersion": "v1", |
25 "documentationLink": "https://cloud.google.com/monitoring/api/", | 26 "documentationLink": "https://cloud.google.com/monitoring/api/", |
26 "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/xW_CLgXez5AZDCw5fhxCvxKwgIc\"", | |
27 "icons": { | 27 "icons": { |
28 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 28 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
29 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 29 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
30 }, | 30 }, |
31 "id": "monitoring:v3", | 31 "id": "monitoring:v3", |
32 "kind": "discovery#restDescription", | 32 "kind": "discovery#restDescription", |
33 "name": "monitoring", | 33 "name": "monitoring", |
34 "ownerDomain": "google.com", | 34 "ownerDomain": "google.com", |
35 "ownerName": "Google", | 35 "ownerName": "Google", |
36 "parameters": { | 36 "parameters": { |
37 "access_token": { | 37 "access_token": { |
38 "description": "OAuth access token.", | 38 "description": "OAuth access token.", |
39 "location": "query", | 39 "location": "query", |
40 "type": "string" | 40 "type": "string" |
41 }, | 41 }, |
| 42 "prettyPrint": { |
| 43 "default": "true", |
| 44 "description": "Returns response with indentations and line breaks."
, |
| 45 "location": "query", |
| 46 "type": "boolean" |
| 47 }, |
| 48 "key": { |
| 49 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 50 "location": "query", |
| 51 "type": "string" |
| 52 }, |
| 53 "quotaUser": { |
| 54 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
| 55 "location": "query", |
| 56 "type": "string" |
| 57 }, |
| 58 "pp": { |
| 59 "default": "true", |
| 60 "description": "Pretty-print response.", |
| 61 "location": "query", |
| 62 "type": "boolean" |
| 63 }, |
| 64 "fields": { |
| 65 "description": "Selector specifying which fields to include in a par
tial response.", |
| 66 "location": "query", |
| 67 "type": "string" |
| 68 }, |
42 "alt": { | 69 "alt": { |
43 "default": "json", | 70 "default": "json", |
44 "description": "Data format for response.", | 71 "description": "Data format for response.", |
| 72 "enum": [ |
| 73 "json", |
| 74 "media", |
| 75 "proto" |
| 76 ], |
45 "enumDescriptions": [ | 77 "enumDescriptions": [ |
46 "Responses with Content-Type of application/json", | 78 "Responses with Content-Type of application/json", |
47 "Media download with context-dependent Content-Type", | 79 "Media download with context-dependent Content-Type", |
48 "Responses with Content-Type of application/x-protobuf" | 80 "Responses with Content-Type of application/x-protobuf" |
49 ], | 81 ], |
50 "location": "query", | 82 "location": "query", |
51 "type": "string" | 83 "type": "string" |
52 }, | 84 }, |
53 "bearer_token": { | 85 "$.xgafv": { |
54 "description": "OAuth bearer token.", | 86 "description": "V1 error format.", |
| 87 "enum": [ |
| 88 "1", |
| 89 "2" |
| 90 ], |
| 91 "enumDescriptions": [ |
| 92 "v1 error format", |
| 93 "v2 error format" |
| 94 ], |
55 "location": "query", | 95 "location": "query", |
56 "type": "string" | 96 "type": "string" |
57 }, | 97 }, |
58 "callback": { | 98 "callback": { |
59 "description": "JSONP", | 99 "description": "JSONP", |
60 "location": "query", | 100 "location": "query", |
61 "type": "string" | 101 "type": "string" |
62 }, | 102 }, |
63 "fields": { | |
64 "description": "Selector specifying which fields to include in a par
tial response.", | |
65 "location": "query", | |
66 "type": "string" | |
67 }, | |
68 "key": { | |
69 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
70 "location": "query", | |
71 "type": "string" | |
72 }, | |
73 "oauth_token": { | 103 "oauth_token": { |
74 "description": "OAuth 2.0 token for the current user.", | 104 "description": "OAuth 2.0 token for the current user.", |
75 "location": "query", | 105 "location": "query", |
76 "type": "string" | 106 "type": "string" |
77 }, | 107 }, |
78 "pp": { | 108 "uploadType": { |
79 "default": "true", | 109 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
80 "description": "Pretty-print response.", | |
81 "location": "query", | |
82 "type": "boolean" | |
83 }, | |
84 "prettyPrint": { | |
85 "default": "true", | |
86 "description": "Returns response with indentations and line breaks."
, | |
87 "location": "query", | |
88 "type": "boolean" | |
89 }, | |
90 "quotaUser": { | |
91 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
92 "location": "query", | 110 "location": "query", |
93 "type": "string" | 111 "type": "string" |
94 }, | 112 }, |
| 113 "bearer_token": { |
| 114 "description": "OAuth bearer token.", |
| 115 "location": "query", |
| 116 "type": "string" |
| 117 }, |
95 "upload_protocol": { | 118 "upload_protocol": { |
96 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 119 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
97 "location": "query", | 120 "location": "query", |
98 "type": "string" | 121 "type": "string" |
99 }, | |
100 "uploadType": { | |
101 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
102 "location": "query", | |
103 "type": "string" | |
104 }, | |
105 "$.xgafv": { | |
106 "description": "V1 error format.", | |
107 "enumDescriptions": [ | |
108 "v1 error format", | |
109 "v2 error format" | |
110 ], | |
111 "location": "query", | |
112 "type": "string" | |
113 } | 122 } |
114 }, | 123 }, |
115 "protocol": "rest", | 124 "protocol": "rest", |
116 "resources": { | 125 "resources": { |
117 "projects": { | 126 "projects": { |
118 "resources": { | 127 "resources": { |
119 "collectdTimeSeries": { | 128 "collectdTimeSeries": { |
120 "methods": { | 129 "methods": { |
121 "create": { | 130 "create": { |
122 "description": "Creates a new time series with the g
iven data points. This method is only for use in `collectd`-related code, includ
ing the Google Monitoring Agent. See [google.monitoring.v3.MetricService.CreateT
imeSeries] instead.", | 131 "description": "Stackdriver Monitoring Agent only: C
reates a new time series.<aside class=\"caution\">This method is only for use by
the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.</asid
e>", |
123 "httpMethod": "POST", | 132 "httpMethod": "POST", |
124 "id": "monitoring.projects.collectdTimeSeries.create
", | 133 "id": "monitoring.projects.collectdTimeSeries.create
", |
125 "parameterOrder": [ | 134 "parameterOrder": [ |
126 "name" | 135 "name" |
127 ], | 136 ], |
128 "parameters": { | 137 "parameters": { |
129 "name": { | 138 "name": { |
130 "description": "The project in which to crea
te the time series. The format is `\"projects/PROJECT_ID_OR_NUMBER\"`.", | 139 "description": "The project in which to crea
te the time series. The format is "projects/PROJECT_ID_OR_NUMBER".", |
131 "location": "path", | 140 "location": "path", |
132 "pattern": "^projects/[^/]*$", | 141 "pattern": "^projects/[^/]+$", |
133 "required": true, | 142 "required": true, |
134 "type": "string" | 143 "type": "string" |
135 } | 144 } |
136 }, | 145 }, |
137 "path": "v3/{+name}/collectdTimeSeries", | 146 "path": "v3/{+name}/collectdTimeSeries", |
138 "request": { | 147 "request": { |
139 "$ref": "CreateCollectdTimeSeriesRequest" | 148 "$ref": "CreateCollectdTimeSeriesRequest" |
140 }, | 149 }, |
141 "response": { | 150 "response": { |
142 "$ref": "Empty" | 151 "$ref": "Empty" |
143 }, | 152 }, |
144 "scopes": [ | 153 "scopes": [ |
145 "https://www.googleapis.com/auth/cloud-platform"
, | 154 "https://www.googleapis.com/auth/cloud-platform"
, |
146 "https://www.googleapis.com/auth/monitoring", | 155 "https://www.googleapis.com/auth/monitoring", |
147 "https://www.googleapis.com/auth/monitoring.writ
e" | 156 "https://www.googleapis.com/auth/monitoring.writ
e" |
148 ] | 157 ] |
149 } | 158 } |
150 } | 159 } |
151 }, | 160 }, |
152 "groups": { | 161 "groups": { |
153 "methods": { | 162 "methods": { |
154 "list": { | 163 "update": { |
155 "description": "Lists the existing groups.", | 164 "description": "Updates an existing group. You can c
hange any group attributes except name.", |
156 "httpMethod": "GET", | 165 "httpMethod": "PUT", |
157 "id": "monitoring.projects.groups.list", | 166 "id": "monitoring.projects.groups.update", |
158 "parameterOrder": [ | 167 "parameterOrder": [ |
159 "name" | 168 "name" |
160 ], | 169 ], |
161 "parameters": { | 170 "parameters": { |
| 171 "validateOnly": { |
| 172 "description": "If true, validate this reque
st but do not update the existing group.", |
| 173 "location": "query", |
| 174 "type": "boolean" |
| 175 }, |
162 "name": { | 176 "name": { |
163 "description": "The project whose groups are
to be listed. The format is `\"projects/{project_id_or_number}\"`.", | 177 "description": "Output only. The name of thi
s group. The format is "projects/{project_id_or_number}/groups/{group_id}&q
uot;. When creating a group, this field is ignored and a new name is created con
sisting of the project specified in the call to CreateGroup and a unique {group_
id} that is generated automatically.", |
164 "location": "path", | 178 "location": "path", |
165 "pattern": "^projects/[^/]*$", | 179 "pattern": "^projects/[^/]+/groups/[^/]+$", |
166 "required": true, | 180 "required": true, |
167 "type": "string" | 181 "type": "string" |
168 }, | |
169 "childrenOfGroup": { | |
170 "description": "A group name: `\"projects/{p
roject_id_or_number}/groups/{group_id}\"`. Returns groups whose `parentName` fie
ld contains the group name. If no groups have this parent, the results are empty
.", | |
171 "location": "query", | |
172 "type": "string" | |
173 }, | |
174 "ancestorsOfGroup": { | |
175 "description": "A group name: `\"projects/{p
roject_id_or_number}/groups/{group_id}\"`. Returns groups that are ancestors of
the specified group. The groups are returned in order, starting with the immedia
te parent and ending with the most distant ancestor. If the specified group has
no immediate parent, the results are empty.", | |
176 "location": "query", | |
177 "type": "string" | |
178 }, | |
179 "descendantsOfGroup": { | |
180 "description": "A group name: `\"projects/{p
roject_id_or_number}/groups/{group_id}\"`. Returns the descendants of the specif
ied group. This is a superset of the results returned by the `childrenOfGroup` f
ilter, and includes children-of-children, and so forth.", | |
181 "location": "query", | |
182 "type": "string" | |
183 }, | |
184 "pageSize": { | |
185 "description": "A positive number that is th
e maximum number of results to return.", | |
186 "format": "int32", | |
187 "location": "query", | |
188 "type": "integer" | |
189 }, | |
190 "pageToken": { | |
191 "description": "If this field is not empty t
hen it must contain the `nextPageToken` value returned by a previous call to thi
s method. Using this field causes the method to return additional results from t
he previous method call.", | |
192 "location": "query", | |
193 "type": "string" | |
194 } | 182 } |
195 }, | 183 }, |
196 "path": "v3/{+name}/groups", | 184 "path": "v3/{+name}", |
| 185 "request": { |
| 186 "$ref": "Group" |
| 187 }, |
197 "response": { | 188 "response": { |
198 "$ref": "ListGroupsResponse" | 189 "$ref": "Group" |
199 }, | 190 }, |
200 "scopes": [ | 191 "scopes": [ |
201 "https://www.googleapis.com/auth/cloud-platform"
, | 192 "https://www.googleapis.com/auth/cloud-platform"
, |
202 "https://www.googleapis.com/auth/monitoring", | 193 "https://www.googleapis.com/auth/monitoring" |
203 "https://www.googleapis.com/auth/monitoring.read
" | |
204 ] | 194 ] |
205 }, | 195 }, |
206 "get": { | 196 "get": { |
207 "description": "Gets a single group.", | 197 "description": "Gets a single group.", |
208 "httpMethod": "GET", | 198 "httpMethod": "GET", |
209 "id": "monitoring.projects.groups.get", | 199 "id": "monitoring.projects.groups.get", |
210 "parameterOrder": [ | 200 "parameterOrder": [ |
211 "name" | 201 "name" |
212 ], | 202 ], |
213 "parameters": { | 203 "parameters": { |
214 "name": { | 204 "name": { |
215 "description": "The group to retrieve. The f
ormat is `\"projects/{project_id_or_number}/groups/{group_id}\"`.", | 205 "description": "The group to retrieve. The f
ormat is "projects/{project_id_or_number}/groups/{group_id}".", |
216 "location": "path", | 206 "location": "path", |
217 "pattern": "^projects/[^/]*/groups/[^/]*$", | 207 "pattern": "^projects/[^/]+/groups/[^/]+$", |
218 "required": true, | 208 "required": true, |
219 "type": "string" | 209 "type": "string" |
220 } | 210 } |
221 }, | 211 }, |
222 "path": "v3/{+name}", | 212 "path": "v3/{+name}", |
223 "response": { | 213 "response": { |
224 "$ref": "Group" | 214 "$ref": "Group" |
225 }, | 215 }, |
226 "scopes": [ | 216 "scopes": [ |
227 "https://www.googleapis.com/auth/cloud-platform"
, | 217 "https://www.googleapis.com/auth/cloud-platform"
, |
228 "https://www.googleapis.com/auth/monitoring", | 218 "https://www.googleapis.com/auth/monitoring", |
229 "https://www.googleapis.com/auth/monitoring.read
" | 219 "https://www.googleapis.com/auth/monitoring.read
" |
230 ] | 220 ] |
231 }, | 221 }, |
232 "create": { | 222 "create": { |
233 "description": "Creates a new group.", | 223 "description": "Creates a new group.", |
234 "httpMethod": "POST", | 224 "httpMethod": "POST", |
235 "id": "monitoring.projects.groups.create", | 225 "id": "monitoring.projects.groups.create", |
236 "parameterOrder": [ | 226 "parameterOrder": [ |
237 "name" | 227 "name" |
238 ], | 228 ], |
239 "parameters": { | 229 "parameters": { |
240 "name": { | |
241 "description": "The project in which to crea
te the group. The format is `\"projects/{project_id_or_number}\"`.", | |
242 "location": "path", | |
243 "pattern": "^projects/[^/]*$", | |
244 "required": true, | |
245 "type": "string" | |
246 }, | |
247 "validateOnly": { | 230 "validateOnly": { |
248 "description": "If true, validate this reque
st but do not create the group.", | 231 "description": "If true, validate this reque
st but do not create the group.", |
249 "location": "query", | 232 "location": "query", |
250 "type": "boolean" | 233 "type": "boolean" |
| 234 }, |
| 235 "name": { |
| 236 "description": "The project in which to crea
te the group. The format is "projects/{project_id_or_number}".", |
| 237 "location": "path", |
| 238 "pattern": "^projects/[^/]+$", |
| 239 "required": true, |
| 240 "type": "string" |
251 } | 241 } |
252 }, | 242 }, |
253 "path": "v3/{+name}/groups", | 243 "path": "v3/{+name}/groups", |
254 "request": { | 244 "request": { |
255 "$ref": "Group" | 245 "$ref": "Group" |
256 }, | 246 }, |
257 "response": { | 247 "response": { |
258 "$ref": "Group" | 248 "$ref": "Group" |
259 }, | 249 }, |
260 "scopes": [ | 250 "scopes": [ |
261 "https://www.googleapis.com/auth/cloud-platform"
, | 251 "https://www.googleapis.com/auth/cloud-platform"
, |
262 "https://www.googleapis.com/auth/monitoring" | 252 "https://www.googleapis.com/auth/monitoring" |
263 ] | 253 ] |
264 }, | 254 }, |
265 "update": { | 255 "list": { |
266 "description": "Updates an existing group. You can c
hange any group attributes except `name`.", | 256 "description": "Lists the existing groups.", |
267 "httpMethod": "PUT", | 257 "httpMethod": "GET", |
268 "id": "monitoring.projects.groups.update", | 258 "id": "monitoring.projects.groups.list", |
269 "parameterOrder": [ | 259 "parameterOrder": [ |
270 "name" | 260 "name" |
271 ], | 261 ], |
272 "parameters": { | 262 "parameters": { |
| 263 "descendantsOfGroup": { |
| 264 "description": "A group name: "projects
/{project_id_or_number}/groups/{group_id}". Returns the descendants of the
specified group. This is a superset of the results returned by the childrenOfGro
up filter, and includes children-of-children, and so forth.", |
| 265 "location": "query", |
| 266 "type": "string" |
| 267 }, |
| 268 "pageSize": { |
| 269 "description": "A positive number that is th
e maximum number of results to return.", |
| 270 "format": "int32", |
| 271 "location": "query", |
| 272 "type": "integer" |
| 273 }, |
| 274 "childrenOfGroup": { |
| 275 "description": "A group name: "projects
/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName
field contains the group name. If no groups have this parent, the results are e
mpty.", |
| 276 "location": "query", |
| 277 "type": "string" |
| 278 }, |
273 "name": { | 279 "name": { |
274 "description": "The name of this group. The
format is `\"projects/{project_id_or_number}/groups/{group_id}\"`. When creating
a group, this field is ignored and a new name is created consisting of the proj
ect specified in the call to `CreateGroup` and a unique `{group_id}` that is gen
erated automatically. @OutputOnly", | 280 "description": "The project whose groups are
to be listed. The format is "projects/{project_id_or_number}".", |
275 "location": "path", | 281 "location": "path", |
276 "pattern": "^projects/[^/]*/groups/[^/]*$", | 282 "pattern": "^projects/[^/]+$", |
277 "required": true, | 283 "required": true, |
278 "type": "string" | 284 "type": "string" |
279 }, | 285 }, |
280 "validateOnly": { | 286 "ancestorsOfGroup": { |
281 "description": "If true, validate this reque
st but do not update the existing group.", | 287 "description": "A group name: "projects
/{project_id_or_number}/groups/{group_id}". Returns groups that are ancesto
rs of the specified group. The groups are returned in order, starting with the i
mmediate parent and ending with the most distant ancestor. If the specified grou
p has no immediate parent, the results are empty.", |
282 "location": "query", | 288 "location": "query", |
283 "type": "boolean" | 289 "type": "string" |
| 290 }, |
| 291 "pageToken": { |
| 292 "description": "If this field is not empty t
hen 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.", |
| 293 "location": "query", |
| 294 "type": "string" |
284 } | 295 } |
285 }, | 296 }, |
286 "path": "v3/{+name}", | 297 "path": "v3/{+name}/groups", |
287 "request": { | |
288 "$ref": "Group" | |
289 }, | |
290 "response": { | 298 "response": { |
291 "$ref": "Group" | 299 "$ref": "ListGroupsResponse" |
292 }, | 300 }, |
293 "scopes": [ | 301 "scopes": [ |
294 "https://www.googleapis.com/auth/cloud-platform"
, | 302 "https://www.googleapis.com/auth/cloud-platform"
, |
295 "https://www.googleapis.com/auth/monitoring" | 303 "https://www.googleapis.com/auth/monitoring", |
| 304 "https://www.googleapis.com/auth/monitoring.read
" |
296 ] | 305 ] |
297 }, | 306 }, |
298 "delete": { | 307 "delete": { |
299 "description": "Deletes an existing group.", | 308 "description": "Deletes an existing group.", |
300 "httpMethod": "DELETE", | 309 "httpMethod": "DELETE", |
301 "id": "monitoring.projects.groups.delete", | 310 "id": "monitoring.projects.groups.delete", |
302 "parameterOrder": [ | 311 "parameterOrder": [ |
303 "name" | 312 "name" |
304 ], | 313 ], |
305 "parameters": { | 314 "parameters": { |
306 "name": { | 315 "name": { |
307 "description": "The group to delete. The for
mat is `\"projects/{project_id_or_number}/groups/{group_id}\"`.", | 316 "description": "The group to delete. The for
mat is "projects/{project_id_or_number}/groups/{group_id}".", |
308 "location": "path", | 317 "location": "path", |
309 "pattern": "^projects/[^/]*/groups/[^/]*$", | 318 "pattern": "^projects/[^/]+/groups/[^/]+$", |
310 "required": true, | 319 "required": true, |
311 "type": "string" | 320 "type": "string" |
312 } | 321 } |
313 }, | 322 }, |
314 "path": "v3/{+name}", | 323 "path": "v3/{+name}", |
315 "response": { | 324 "response": { |
316 "$ref": "Empty" | 325 "$ref": "Empty" |
317 }, | 326 }, |
318 "scopes": [ | 327 "scopes": [ |
319 "https://www.googleapis.com/auth/cloud-platform"
, | 328 "https://www.googleapis.com/auth/cloud-platform"
, |
320 "https://www.googleapis.com/auth/monitoring" | 329 "https://www.googleapis.com/auth/monitoring" |
321 ] | 330 ] |
322 } | 331 } |
323 }, | 332 }, |
324 "resources": { | 333 "resources": { |
325 "members": { | 334 "members": { |
326 "methods": { | 335 "methods": { |
327 "list": { | 336 "list": { |
328 "description": "Lists the monitored resource
s that are members of a group.", | 337 "description": "Lists the monitored resource
s that are members of a group.", |
329 "httpMethod": "GET", | 338 "httpMethod": "GET", |
330 "id": "monitoring.projects.groups.members.li
st", | 339 "id": "monitoring.projects.groups.members.li
st", |
331 "parameterOrder": [ | 340 "parameterOrder": [ |
332 "name" | 341 "name" |
333 ], | 342 ], |
334 "parameters": { | 343 "parameters": { |
335 "name": { | 344 "filter": { |
336 "description": "The group whose memb
ers are listed. The format is `\"projects/{project_id_or_number}/groups/{group_i
d}\"`.", | 345 "description": "An optional list fil
ter (/monitoring/api/learn_more#filtering) describing the members to be returned
. The filter may reference the type, labels, and metadata of monitored resources
that comprise the group. For example, to return only resources representing Com
pute Engine VM instances, use this filter:\nresource.type = "gce_instance&q
uot;\n", |
337 "location": "path", | 346 "location": "query", |
338 "pattern": "^projects/[^/]*/groups/[
^/]*$", | 347 "type": "string" |
339 "required": true, | 348 }, |
| 349 "interval.endTime": { |
| 350 "description": "Required. The end of
the time interval.", |
| 351 "format": "google-datetime", |
| 352 "location": "query", |
| 353 "type": "string" |
| 354 }, |
| 355 "interval.startTime": { |
| 356 "description": "Optional. The beginn
ing of the time interval. The default value for the start time is the end time.
The start time must not be later than the end time.", |
| 357 "format": "google-datetime", |
| 358 "location": "query", |
340 "type": "string" | 359 "type": "string" |
341 }, | 360 }, |
342 "pageSize": { | 361 "pageSize": { |
343 "description": "A positive number th
at is the maximum number of results to return.", | 362 "description": "A positive number th
at is the maximum number of results to return.", |
344 "format": "int32", | 363 "format": "int32", |
345 "location": "query", | 364 "location": "query", |
346 "type": "integer" | 365 "type": "integer" |
347 }, | 366 }, |
348 "pageToken": { | 367 "name": { |
349 "description": "If this field is not
empty then it must contain the `nextPageToken` value returned by a previous cal
l to this method. Using this field causes the method to return additional result
s from the previous method call.", | 368 "description": "The group whose memb
ers are listed. The format is "projects/{project_id_or_number}/groups/{grou
p_id}".", |
350 "location": "query", | 369 "location": "path", |
| 370 "pattern": "^projects/[^/]+/groups/[
^/]+$", |
| 371 "required": true, |
351 "type": "string" | 372 "type": "string" |
352 }, | 373 }, |
353 "filter": { | 374 "pageToken": { |
354 "description": "An optional [list fi
lter](/monitoring/api/learn_more#filtering) describing the members to be returne
d. The filter may reference the type, labels, and metadata of monitored resource
s that comprise the group. For example, to return only resources representing Co
mpute Engine VM instances, use this filter: resource.type = \"gce_instance\"", | 375 "description": "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.", |
355 "location": "query", | |
356 "type": "string" | |
357 }, | |
358 "interval.endTime": { | |
359 "description": "Required. The end of
the interval. The interval includes this time.", | |
360 "location": "query", | |
361 "type": "string" | |
362 }, | |
363 "interval.startTime": { | |
364 "description": "If this value is omi
tted, the interval is a point in time, `endTime`. If `startTime` is present, it
must be earlier than (less than) `endTime`. The interval begins after `startTime
`—it does not include `startTime`.", | |
365 "location": "query", | 376 "location": "query", |
366 "type": "string" | 377 "type": "string" |
367 } | 378 } |
368 }, | 379 }, |
369 "path": "v3/{+name}/members", | 380 "path": "v3/{+name}/members", |
370 "response": { | 381 "response": { |
371 "$ref": "ListGroupMembersResponse" | 382 "$ref": "ListGroupMembersResponse" |
372 }, | 383 }, |
373 "scopes": [ | 384 "scopes": [ |
374 "https://www.googleapis.com/auth/cloud-p
latform", | 385 "https://www.googleapis.com/auth/cloud-p
latform", |
375 "https://www.googleapis.com/auth/monitor
ing", | 386 "https://www.googleapis.com/auth/monitor
ing", |
376 "https://www.googleapis.com/auth/monitor
ing.read" | 387 "https://www.googleapis.com/auth/monitor
ing.read" |
377 ] | 388 ] |
378 } | 389 } |
379 } | 390 } |
380 } | 391 } |
381 } | 392 } |
382 }, | 393 }, |
383 "monitoredResourceDescriptors": { | 394 "metricDescriptors": { |
384 "methods": { | 395 "methods": { |
385 "list": { | 396 "get": { |
386 "description": "Lists monitored resource descriptors
that match a filter. This method does not require a Stackdriver account.", | 397 "description": "Gets a single metric descriptor. Thi
s method does not require a Stackdriver account.", |
387 "httpMethod": "GET", | 398 "httpMethod": "GET", |
388 "id": "monitoring.projects.monitoredResourceDescript
ors.list", | 399 "id": "monitoring.projects.metricDescriptors.get", |
389 "parameterOrder": [ | 400 "parameterOrder": [ |
390 "name" | 401 "name" |
391 ], | 402 ], |
392 "parameters": { | 403 "parameters": { |
393 "name": { | 404 "name": { |
394 "description": "The project on which to exec
ute the request. The format is `\"projects/{project_id_or_number}\"`.", | 405 "description": "The metric descriptor on whi
ch to execute the request. The format is "projects/{project_id_or_number}/m
etricDescriptors/{metric_id}". An example value of {metric_id} is "com
pute.googleapis.com/instance/disk/read_bytes_count".", |
395 "location": "path", | 406 "location": "path", |
396 "pattern": "^projects/[^/]*$", | 407 "pattern": "^projects/[^/]+/metricDescriptor
s/.+$", |
397 "required": true, | 408 "required": true, |
398 "type": "string" | 409 "type": "string" |
399 }, | |
400 "filter": { | |
401 "description": "An optional [filter](/monito
ring/api/v3/filters) describing the descriptors to be returned. The filter can r
eference the descriptor's type and labels. For example, the following filter ret
urns only Google Compute Engine descriptors that have an `id` label: resource.ty
pe = starts_with(\"gce_\") AND resource.label:id", | |
402 "location": "query", | |
403 "type": "string" | |
404 }, | |
405 "pageSize": { | |
406 "description": "A positive number that is th
e maximum number of results to return.", | |
407 "format": "int32", | |
408 "location": "query", | |
409 "type": "integer" | |
410 }, | |
411 "pageToken": { | |
412 "description": "If this field is not empty t
hen it must contain the `nextPageToken` value returned by a previous call to thi
s method. Using this field causes the method to return additional results from t
he previous method call.", | |
413 "location": "query", | |
414 "type": "string" | |
415 } | 410 } |
416 }, | 411 }, |
417 "path": "v3/{+name}/monitoredResourceDescriptors", | 412 "path": "v3/{+name}", |
418 "response": { | 413 "response": { |
419 "$ref": "ListMonitoredResourceDescriptorsRespons
e" | 414 "$ref": "MetricDescriptor" |
420 }, | 415 }, |
421 "scopes": [ | 416 "scopes": [ |
422 "https://www.googleapis.com/auth/cloud-platform"
, | 417 "https://www.googleapis.com/auth/cloud-platform"
, |
423 "https://www.googleapis.com/auth/monitoring", | 418 "https://www.googleapis.com/auth/monitoring", |
424 "https://www.googleapis.com/auth/monitoring.read
", | 419 "https://www.googleapis.com/auth/monitoring.read
", |
425 "https://www.googleapis.com/auth/monitoring.writ
e" | 420 "https://www.googleapis.com/auth/monitoring.writ
e" |
426 ] | 421 ] |
427 }, | 422 }, |
428 "get": { | 423 "create": { |
429 "description": "Gets a single monitored resource des
criptor. This method does not require a Stackdriver account.", | 424 "description": "Creates a new metric descriptor. Use
r-created metric descriptors define custom metrics (/monitoring/custom-metrics).
", |
430 "httpMethod": "GET", | 425 "httpMethod": "POST", |
431 "id": "monitoring.projects.monitoredResourceDescript
ors.get", | 426 "id": "monitoring.projects.metricDescriptors.create"
, |
432 "parameterOrder": [ | 427 "parameterOrder": [ |
433 "name" | 428 "name" |
434 ], | 429 ], |
435 "parameters": { | 430 "parameters": { |
436 "name": { | 431 "name": { |
437 "description": "The monitored resource descr
iptor to get. The format is `\"projects/{project_id_or_number}/monitoredResource
Descriptors/{resource_type}\"`. The `{resource_type}` is a predefined type, such
as `cloudsql_database`.", | 432 "description": "The project on which to exec
ute the request. The format is "projects/{project_id_or_number}".", |
438 "location": "path", | 433 "location": "path", |
439 "pattern": "^projects/[^/]*/monitoredResourc
eDescriptors/[^/]*$", | 434 "pattern": "^projects/[^/]+$", |
440 "required": true, | 435 "required": true, |
441 "type": "string" | 436 "type": "string" |
442 } | 437 } |
443 }, | 438 }, |
444 "path": "v3/{+name}", | 439 "path": "v3/{+name}/metricDescriptors", |
| 440 "request": { |
| 441 "$ref": "MetricDescriptor" |
| 442 }, |
445 "response": { | 443 "response": { |
446 "$ref": "MonitoredResourceDescriptor" | 444 "$ref": "MetricDescriptor" |
447 }, | 445 }, |
448 "scopes": [ | 446 "scopes": [ |
449 "https://www.googleapis.com/auth/cloud-platform"
, | 447 "https://www.googleapis.com/auth/cloud-platform"
, |
450 "https://www.googleapis.com/auth/monitoring", | 448 "https://www.googleapis.com/auth/monitoring", |
451 "https://www.googleapis.com/auth/monitoring.read
", | |
452 "https://www.googleapis.com/auth/monitoring.writ
e" | 449 "https://www.googleapis.com/auth/monitoring.writ
e" |
453 ] | 450 ] |
454 } | 451 }, |
455 } | |
456 }, | |
457 "metricDescriptors": { | |
458 "methods": { | |
459 "list": { | 452 "list": { |
460 "description": "Lists metric descriptors that match
a filter. This method does not require a Stackdriver account.", | 453 "description": "Lists metric descriptors that match
a filter. This method does not require a Stackdriver account.", |
461 "httpMethod": "GET", | 454 "httpMethod": "GET", |
462 "id": "monitoring.projects.metricDescriptors.list", | 455 "id": "monitoring.projects.metricDescriptors.list", |
463 "parameterOrder": [ | 456 "parameterOrder": [ |
464 "name" | 457 "name" |
465 ], | 458 ], |
466 "parameters": { | 459 "parameters": { |
467 "name": { | |
468 "description": "The project on which to exec
ute the request. The format is `\"projects/{project_id_or_number}\"`.", | |
469 "location": "path", | |
470 "pattern": "^projects/[^/]*$", | |
471 "required": true, | |
472 "type": "string" | |
473 }, | |
474 "filter": { | |
475 "description": "If this field is empty, all
custom and system-defined metric descriptors are returned. Otherwise, the [filte
r](/monitoring/api/v3/filters) specifies which metric descriptors are to be retu
rned. For example, the following filter matches all [custom metrics](/monitoring
/custom-metrics): metric.type = starts_with(\"custom.googleapis.com/\")", | |
476 "location": "query", | |
477 "type": "string" | |
478 }, | |
479 "pageSize": { | 460 "pageSize": { |
480 "description": "A positive number that is th
e maximum number of results to return.", | 461 "description": "A positive number that is th
e maximum number of results to return.", |
481 "format": "int32", | 462 "format": "int32", |
482 "location": "query", | 463 "location": "query", |
483 "type": "integer" | 464 "type": "integer" |
484 }, | 465 }, |
| 466 "filter": { |
| 467 "description": "If this field is empty, all
custom and system-defined metric descriptors are returned. Otherwise, the filter
(/monitoring/api/v3/filters) specifies which metric descriptors are to be retur
ned. For example, the following filter matches all custom metrics (/monitoring/c
ustom-metrics):\nmetric.type = starts_with("custom.googleapis.com/")\n
", |
| 468 "location": "query", |
| 469 "type": "string" |
| 470 }, |
| 471 "name": { |
| 472 "description": "The project on which to exec
ute the request. The format is "projects/{project_id_or_number}".", |
| 473 "location": "path", |
| 474 "pattern": "^projects/[^/]+$", |
| 475 "required": true, |
| 476 "type": "string" |
| 477 }, |
485 "pageToken": { | 478 "pageToken": { |
486 "description": "If this field is not empty t
hen it must contain the `nextPageToken` value returned by a previous call to thi
s method. Using this field causes the method to return additional results from t
he previous method call.", | 479 "description": "If this field is not empty t
hen 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.", |
487 "location": "query", | 480 "location": "query", |
488 "type": "string" | 481 "type": "string" |
489 } | 482 } |
490 }, | 483 }, |
491 "path": "v3/{+name}/metricDescriptors", | 484 "path": "v3/{+name}/metricDescriptors", |
492 "response": { | 485 "response": { |
493 "$ref": "ListMetricDescriptorsResponse" | 486 "$ref": "ListMetricDescriptorsResponse" |
494 }, | 487 }, |
495 "scopes": [ | 488 "scopes": [ |
496 "https://www.googleapis.com/auth/cloud-platform"
, | 489 "https://www.googleapis.com/auth/cloud-platform"
, |
497 "https://www.googleapis.com/auth/monitoring", | 490 "https://www.googleapis.com/auth/monitoring", |
498 "https://www.googleapis.com/auth/monitoring.read
", | 491 "https://www.googleapis.com/auth/monitoring.read
", |
499 "https://www.googleapis.com/auth/monitoring.writ
e" | 492 "https://www.googleapis.com/auth/monitoring.writ
e" |
500 ] | 493 ] |
501 }, | 494 }, |
502 "get": { | 495 "delete": { |
503 "description": "Gets a single metric descriptor. Thi
s method does not require a Stackdriver account.", | 496 "description": "Deletes a metric descriptor. Only us
er-created custom metrics (/monitoring/custom-metrics) can be deleted.", |
504 "httpMethod": "GET", | 497 "httpMethod": "DELETE", |
505 "id": "monitoring.projects.metricDescriptors.get", | 498 "id": "monitoring.projects.metricDescriptors.delete"
, |
506 "parameterOrder": [ | 499 "parameterOrder": [ |
507 "name" | 500 "name" |
508 ], | 501 ], |
509 "parameters": { | 502 "parameters": { |
510 "name": { | 503 "name": { |
511 "description": "The metric descriptor on whi
ch to execute the request. The format is `\"projects/{project_id_or_number}/metr
icDescriptors/{metric_id}\"`. An example value of `{metric_id}` is `\"compute.go
ogleapis.com/instance/disk/read_bytes_count\"`.", | 504 "description": "The metric descriptor on whi
ch to execute the request. The format is "projects/{project_id_or_number}/m
etricDescriptors/{metric_id}". An example of {metric_id} is: "custom.g
oogleapis.com/my_test_metric".", |
512 "location": "path", | 505 "location": "path", |
513 "pattern": "^projects/[^/]*/metricDescriptor
s/.*$", | 506 "pattern": "^projects/[^/]+/metricDescriptor
s/.+$", |
514 "required": true, | 507 "required": true, |
515 "type": "string" | 508 "type": "string" |
516 } | 509 } |
517 }, | 510 }, |
518 "path": "v3/{+name}", | 511 "path": "v3/{+name}", |
519 "response": { | 512 "response": { |
520 "$ref": "MetricDescriptor" | 513 "$ref": "Empty" |
521 }, | 514 }, |
522 "scopes": [ | 515 "scopes": [ |
523 "https://www.googleapis.com/auth/cloud-platform"
, | 516 "https://www.googleapis.com/auth/cloud-platform"
, |
524 "https://www.googleapis.com/auth/monitoring", | 517 "https://www.googleapis.com/auth/monitoring" |
525 "https://www.googleapis.com/auth/monitoring.read
", | |
526 "https://www.googleapis.com/auth/monitoring.writ
e" | |
527 ] | 518 ] |
528 }, | 519 } |
| 520 } |
| 521 }, |
| 522 "timeSeries": { |
| 523 "methods": { |
529 "create": { | 524 "create": { |
530 "description": "Creates a new metric descriptor. Use
r-created metric descriptors define [custom metrics](/monitoring/custom-metrics)
.", | 525 "description": "Creates or adds data to one or more
time series. The response is empty if all time series in the request were writte
n. If any time series could not be written, a corresponding failure message is i
ncluded in the error response.", |
531 "httpMethod": "POST", | 526 "httpMethod": "POST", |
532 "id": "monitoring.projects.metricDescriptors.create"
, | 527 "id": "monitoring.projects.timeSeries.create", |
533 "parameterOrder": [ | 528 "parameterOrder": [ |
534 "name" | 529 "name" |
535 ], | 530 ], |
536 "parameters": { | 531 "parameters": { |
537 "name": { | 532 "name": { |
538 "description": "The project on which to exec
ute the request. The format is `\"projects/{project_id_or_number}\"`.", | 533 "description": "The project on which to exec
ute the request. The format is "projects/{project_id_or_number}".", |
539 "location": "path", | 534 "location": "path", |
540 "pattern": "^projects/[^/]*$", | 535 "pattern": "^projects/[^/]+$", |
541 "required": true, | 536 "required": true, |
542 "type": "string" | 537 "type": "string" |
543 } | 538 } |
544 }, | 539 }, |
545 "path": "v3/{+name}/metricDescriptors", | 540 "path": "v3/{+name}/timeSeries", |
546 "request": { | 541 "request": { |
547 "$ref": "MetricDescriptor" | 542 "$ref": "CreateTimeSeriesRequest" |
548 }, | 543 }, |
549 "response": { | 544 "response": { |
550 "$ref": "MetricDescriptor" | 545 "$ref": "Empty" |
551 }, | 546 }, |
552 "scopes": [ | 547 "scopes": [ |
553 "https://www.googleapis.com/auth/cloud-platform"
, | 548 "https://www.googleapis.com/auth/cloud-platform"
, |
554 "https://www.googleapis.com/auth/monitoring", | 549 "https://www.googleapis.com/auth/monitoring", |
555 "https://www.googleapis.com/auth/monitoring.writ
e" | 550 "https://www.googleapis.com/auth/monitoring.writ
e" |
556 ] | 551 ] |
557 }, | 552 }, |
558 "delete": { | |
559 "description": "Deletes a metric descriptor. Only us
er-created [custom metrics](/monitoring/custom-metrics) can be deleted.", | |
560 "httpMethod": "DELETE", | |
561 "id": "monitoring.projects.metricDescriptors.delete"
, | |
562 "parameterOrder": [ | |
563 "name" | |
564 ], | |
565 "parameters": { | |
566 "name": { | |
567 "description": "The metric descriptor on whi
ch to execute the request. The format is `\"projects/{project_id_or_number}/metr
icDescriptors/{metric_id}\"`. An example of `{metric_id}` is: `\"custom.googleap
is.com/my_test_metric\"`.", | |
568 "location": "path", | |
569 "pattern": "^projects/[^/]*/metricDescriptor
s/.*$", | |
570 "required": true, | |
571 "type": "string" | |
572 } | |
573 }, | |
574 "path": "v3/{+name}", | |
575 "response": { | |
576 "$ref": "Empty" | |
577 }, | |
578 "scopes": [ | |
579 "https://www.googleapis.com/auth/cloud-platform"
, | |
580 "https://www.googleapis.com/auth/monitoring" | |
581 ] | |
582 } | |
583 } | |
584 }, | |
585 "timeSeries": { | |
586 "methods": { | |
587 "list": { | 553 "list": { |
588 "description": "Lists time series that match a filte
r. This method does not require a Stackdriver account.", | 554 "description": "Lists time series that match a filte
r. This method does not require a Stackdriver account.", |
589 "httpMethod": "GET", | 555 "httpMethod": "GET", |
590 "id": "monitoring.projects.timeSeries.list", | 556 "id": "monitoring.projects.timeSeries.list", |
591 "parameterOrder": [ | 557 "parameterOrder": [ |
592 "name" | 558 "name" |
593 ], | 559 ], |
594 "parameters": { | 560 "parameters": { |
595 "name": { | |
596 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", | |
597 "location": "path", | |
598 "pattern": "^projects/[^/]*$", | |
599 "required": true, | |
600 "type": "string" | |
601 }, | |
602 "filter": { | 561 "filter": { |
603 "description": "A [monitoring filter](/monit
oring/api/v3/filters) that specifies which time series should be returned. The f
ilter must specify a single metric type, and can additionally specify metric lab
els and other information. For example: metric.type = \"compute.googleapis.com/i
nstance/cpu/usage_time\" AND metric.label.instance_name = \"my-instance-name\"", | 562 "description": "A monitoring filter (/monito
ring/api/v3/filters) that specifies which time series should be returned. The fi
lter must specify a single metric type, and can additionally specify metric labe
ls and other information. For example:\nmetric.type = "compute.googleapis.c
om/instance/cpu/usage_time" AND\n metric.label.instance_name = "my-
instance-name"\n", |
604 "location": "query", | 563 "location": "query", |
605 "type": "string" | 564 "type": "string" |
606 }, | 565 }, |
607 "interval.endTime": { | 566 "aggregation.groupByFields": { |
608 "description": "Required. The end of the int
erval. The interval includes this time.", | 567 "description": "The set of fields to preserv
e when crossSeriesReducer is specified. The groupByFields determine how the time
series are partitioned into subsets prior to applying the aggregation function.
Each subset contains time series that have the same value for each of the group
ing fields. Each individual time series is a member of exactly one subset. The c
rossSeriesReducer is applied to each subset of time series. Fields not specified
in groupByFields are aggregated away. If groupByFields is not specified, the ti
me series are aggregated into a single output time series. If crossSeriesReducer
is not defined, this field is ignored.", |
609 "location": "query", | 568 "location": "query", |
610 "type": "string" | 569 "repeated": true, |
611 }, | |
612 "interval.startTime": { | |
613 "description": "If this value is omitted, th
e interval is a point in time, `endTime`. If `startTime` is present, it must be
earlier than (less than) `endTime`. The interval begins after `startTime`—it doe
s not include `startTime`.", | |
614 "location": "query", | |
615 "type": "string" | |
616 }, | |
617 "aggregation.alignmentPeriod": { | |
618 "description": "The alignment period for per
-[time series](TimeSeries) alignment. If present, `alignmentPeriod` must be at l
east 60 seconds. After per-time series alignment, each time series will contain
data points only on the period boundaries. If `perSeriesAligner` is not specifie
d or equals `ALIGN_NONE`, then this field is ignored. If `perSeriesAligner` is s
pecified and does not equal `ALIGN_NONE`, then this field must be defined; other
wise an error is returned.", | |
619 "location": "query", | |
620 "type": "string" | |
621 }, | |
622 "aggregation.perSeriesAligner": { | |
623 "description": "The approach to be used to a
lign individual time series. Not all alignment functions may be applied to all t
ime series, depending on the metric type and value type of the original time ser
ies. Alignment may change the metric type or the value type of the time series.
Time series data must be aligned in order to perform cross-time series reduction
. If `crossSeriesReducer` is specified, then `perSeriesAligner` must be specifie
d and not equal `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise,
an error is returned.", | |
624 "enum": [ | |
625 "ALIGN_NONE", | |
626 "ALIGN_DELTA", | |
627 "ALIGN_RATE", | |
628 "ALIGN_INTERPOLATE", | |
629 "ALIGN_NEXT_OLDER", | |
630 "ALIGN_MIN", | |
631 "ALIGN_MAX", | |
632 "ALIGN_MEAN", | |
633 "ALIGN_COUNT", | |
634 "ALIGN_SUM", | |
635 "ALIGN_STDDEV", | |
636 "ALIGN_COUNT_TRUE", | |
637 "ALIGN_FRACTION_TRUE" | |
638 ], | |
639 "location": "query", | |
640 "type": "string" | 570 "type": "string" |
641 }, | 571 }, |
642 "aggregation.crossSeriesReducer": { | 572 "aggregation.crossSeriesReducer": { |
643 "description": "The approach to be used to c
ombine time series. Not all reducer functions may be applied to all time series,
depending on the metric type and the value type of the original time series. Re
duction may change the metric type of value type of the time series. Time series
data must be aligned in order to perform cross-time series reduction. If `cross
SeriesReducer` is specified, then `perSeriesAligner` must be specified and not e
qual `ALIGN_NONE` and `alignmentPeriod` must be specified; otherwise, an error i
s returned.", | 573 "description": "The approach to be used to c
ombine time series. Not all reducer functions may be applied to all time series,
depending on the metric type and the value type of the original time series. Re
duction may change the metric type of value type of the time series.Time series
data must be aligned in order to perform cross-time series reduction. If crossSe
riesReducer is specified, then perSeriesAligner must be specified and not equal
ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returne
d.", |
644 "enum": [ | 574 "enum": [ |
645 "REDUCE_NONE", | 575 "REDUCE_NONE", |
646 "REDUCE_MEAN", | 576 "REDUCE_MEAN", |
647 "REDUCE_MIN", | 577 "REDUCE_MIN", |
648 "REDUCE_MAX", | 578 "REDUCE_MAX", |
649 "REDUCE_SUM", | 579 "REDUCE_SUM", |
650 "REDUCE_STDDEV", | 580 "REDUCE_STDDEV", |
651 "REDUCE_COUNT", | 581 "REDUCE_COUNT", |
652 "REDUCE_COUNT_TRUE", | 582 "REDUCE_COUNT_TRUE", |
653 "REDUCE_FRACTION_TRUE", | 583 "REDUCE_FRACTION_TRUE", |
654 "REDUCE_PERCENTILE_99", | 584 "REDUCE_PERCENTILE_99", |
655 "REDUCE_PERCENTILE_95", | 585 "REDUCE_PERCENTILE_95", |
656 "REDUCE_PERCENTILE_50", | 586 "REDUCE_PERCENTILE_50", |
657 "REDUCE_PERCENTILE_05" | 587 "REDUCE_PERCENTILE_05" |
658 ], | 588 ], |
659 "location": "query", | 589 "location": "query", |
660 "type": "string" | 590 "type": "string" |
661 }, | 591 }, |
662 "aggregation.groupByFields": { | 592 "interval.endTime": { |
663 "description": "The set of fields to preserv
e when `crossSeriesReducer` is specified. The `groupByFields` determine how the
time series are partitioned into subsets prior to applying the aggregation funct
ion. Each subset contains time series that have the same value for each of the g
rouping fields. Each individual time series is a member of exactly one subset. T
he `crossSeriesReducer` is applied to each subset of time series. Fields not spe
cified in `groupByFields` are aggregated away. If `groupByFields` is not specifi
ed, the time series are aggregated into a single output time series. If `crossSe
riesReducer` is not defined, this field is ignored.", | 593 "description": "Required. The end of the tim
e interval.", |
| 594 "format": "google-datetime", |
664 "location": "query", | 595 "location": "query", |
665 "repeated": true, | |
666 "type": "string" | 596 "type": "string" |
667 }, | 597 }, |
668 "orderBy": { | 598 "interval.startTime": { |
669 "description": "Specifies the order in which
the points of the time series should be returned. By default, results are not o
rdered. Currently, this field must be left blank.", | 599 "description": "Optional. The beginning of t
he time interval. The default value for the start time is the end time. The star
t time must not be later than the end time.", |
| 600 "format": "google-datetime", |
670 "location": "query", | 601 "location": "query", |
671 "type": "string" | 602 "type": "string" |
672 }, | 603 }, |
| 604 "pageSize": { |
| 605 "description": "A positive number that is th
e maximum number of results to return. When view field sets to FULL, it limits t
he number of Points server will return; if view field is HEADERS, it limits the
number of TimeSeries server will return.", |
| 606 "format": "int32", |
| 607 "location": "query", |
| 608 "type": "integer" |
| 609 }, |
673 "view": { | 610 "view": { |
674 "description": "Specifies which information
is returned about the time series.", | 611 "description": "Specifies which information
is returned about the time series.", |
675 "enum": [ | 612 "enum": [ |
676 "FULL", | 613 "FULL", |
677 "HEADERS" | 614 "HEADERS" |
678 ], | 615 ], |
679 "location": "query", | 616 "location": "query", |
680 "type": "string" | 617 "type": "string" |
681 }, | 618 }, |
682 "pageSize": { | 619 "name": { |
683 "description": "A positive number that is th
e maximum number of results to return. When `view` field sets to `FULL`, it limi
ts the number of `Points` server will return; if `view` field is `HEADERS`, it l
imits the number of `TimeSeries` server will return.", | 620 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", |
684 "format": "int32", | 621 "location": "path", |
| 622 "pattern": "^projects/[^/]+$", |
| 623 "required": true, |
| 624 "type": "string" |
| 625 }, |
| 626 "aggregation.alignmentPeriod": { |
| 627 "description": "The alignment period for per
-time series alignment. If present, alignmentPeriod must be at least 60 seconds.
After per-time series alignment, each time series will contain data points only
on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_
NONE, then this field is ignored. If perSeriesAligner is specified and does not
equal ALIGN_NONE, then this field must be defined; otherwise an error is returne
d.", |
| 628 "format": "google-duration", |
685 "location": "query", | 629 "location": "query", |
686 "type": "integer" | 630 "type": "string" |
| 631 }, |
| 632 "aggregation.perSeriesAligner": { |
| 633 "description": "The approach to be used to a
lign individual time series. Not all alignment functions may be applied to all t
ime series, depending on the metric type and value type of the original time ser
ies. Alignment may change the metric type or the value type of the time series.T
ime series data must be aligned in order to perform cross-time series reduction.
If crossSeriesReducer is specified, then perSeriesAligner must be specified and
not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error
is returned.", |
| 634 "enum": [ |
| 635 "ALIGN_NONE", |
| 636 "ALIGN_DELTA", |
| 637 "ALIGN_RATE", |
| 638 "ALIGN_INTERPOLATE", |
| 639 "ALIGN_NEXT_OLDER", |
| 640 "ALIGN_MIN", |
| 641 "ALIGN_MAX", |
| 642 "ALIGN_MEAN", |
| 643 "ALIGN_COUNT", |
| 644 "ALIGN_SUM", |
| 645 "ALIGN_STDDEV", |
| 646 "ALIGN_COUNT_TRUE", |
| 647 "ALIGN_FRACTION_TRUE", |
| 648 "ALIGN_PERCENTILE_99", |
| 649 "ALIGN_PERCENTILE_95", |
| 650 "ALIGN_PERCENTILE_50", |
| 651 "ALIGN_PERCENTILE_05" |
| 652 ], |
| 653 "location": "query", |
| 654 "type": "string" |
| 655 }, |
| 656 "orderBy": { |
| 657 "description": "Specifies the order in which
the points of the time series should be returned. By default, results are not o
rdered. Currently, this field must be left blank.", |
| 658 "location": "query", |
| 659 "type": "string" |
687 }, | 660 }, |
688 "pageToken": { | 661 "pageToken": { |
689 "description": "If this field is not empty t
hen it must contain the `nextPageToken` value returned by a previous call to thi
s method. Using this field causes the method to return additional results from t
he previous method call.", | 662 "description": "If this field is not empty t
hen 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.", |
690 "location": "query", | 663 "location": "query", |
691 "type": "string" | 664 "type": "string" |
692 } | 665 } |
693 }, | 666 }, |
694 "path": "v3/{+name}/timeSeries", | 667 "path": "v3/{+name}/timeSeries", |
695 "response": { | 668 "response": { |
696 "$ref": "ListTimeSeriesResponse" | 669 "$ref": "ListTimeSeriesResponse" |
697 }, | 670 }, |
698 "scopes": [ | 671 "scopes": [ |
699 "https://www.googleapis.com/auth/cloud-platform"
, | 672 "https://www.googleapis.com/auth/cloud-platform"
, |
700 "https://www.googleapis.com/auth/monitoring", | 673 "https://www.googleapis.com/auth/monitoring", |
701 "https://www.googleapis.com/auth/monitoring.read
" | 674 "https://www.googleapis.com/auth/monitoring.read
" |
702 ] | 675 ] |
703 }, | 676 } |
704 "create": { | 677 } |
705 "description": "Creates or adds data to one or more
time series. The response is empty if all time series in the request were writte
n. If any time series could not be written, a corresponding failure message is i
ncluded in the error response.", | 678 }, |
706 "httpMethod": "POST", | 679 "monitoredResourceDescriptors": { |
707 "id": "monitoring.projects.timeSeries.create", | 680 "methods": { |
| 681 "get": { |
| 682 "description": "Gets a single monitored resource des
criptor. This method does not require a Stackdriver account.", |
| 683 "httpMethod": "GET", |
| 684 "id": "monitoring.projects.monitoredResourceDescript
ors.get", |
708 "parameterOrder": [ | 685 "parameterOrder": [ |
709 "name" | 686 "name" |
710 ], | 687 ], |
711 "parameters": { | 688 "parameters": { |
712 "name": { | 689 "name": { |
713 "description": "The project on which to exec
ute the request. The format is `\"projects/{project_id_or_number}\"`.", | 690 "description": "The monitored resource descr
iptor to get. The format is "projects/{project_id_or_number}/monitoredResou
rceDescriptors/{resource_type}". The {resource_type} is a predefined type,
such as cloudsql_database.", |
714 "location": "path", | 691 "location": "path", |
715 "pattern": "^projects/[^/]*$", | 692 "pattern": "^projects/[^/]+/monitoredResourc
eDescriptors/[^/]+$", |
716 "required": true, | 693 "required": true, |
717 "type": "string" | 694 "type": "string" |
718 } | 695 } |
719 }, | 696 }, |
720 "path": "v3/{+name}/timeSeries", | 697 "path": "v3/{+name}", |
721 "request": { | |
722 "$ref": "CreateTimeSeriesRequest" | |
723 }, | |
724 "response": { | 698 "response": { |
725 "$ref": "Empty" | 699 "$ref": "MonitoredResourceDescriptor" |
726 }, | 700 }, |
727 "scopes": [ | 701 "scopes": [ |
728 "https://www.googleapis.com/auth/cloud-platform"
, | 702 "https://www.googleapis.com/auth/cloud-platform"
, |
729 "https://www.googleapis.com/auth/monitoring", | 703 "https://www.googleapis.com/auth/monitoring", |
| 704 "https://www.googleapis.com/auth/monitoring.read
", |
| 705 "https://www.googleapis.com/auth/monitoring.writ
e" |
| 706 ] |
| 707 }, |
| 708 "list": { |
| 709 "description": "Lists monitored resource descriptors
that match a filter. This method does not require a Stackdriver account.", |
| 710 "httpMethod": "GET", |
| 711 "id": "monitoring.projects.monitoredResourceDescript
ors.list", |
| 712 "parameterOrder": [ |
| 713 "name" |
| 714 ], |
| 715 "parameters": { |
| 716 "pageSize": { |
| 717 "description": "A positive number that is th
e maximum number of results to return.", |
| 718 "format": "int32", |
| 719 "location": "query", |
| 720 "type": "integer" |
| 721 }, |
| 722 "filter": { |
| 723 "description": "An optional filter (/monitor
ing/api/v3/filters) describing the descriptors to be returned. The filter can re
ference the descriptor's type and labels. For example, the following filter retu
rns only Google Compute Engine descriptors that have an id label:\nresource.type
= starts_with("gce_") AND resource.label:id\n", |
| 724 "location": "query", |
| 725 "type": "string" |
| 726 }, |
| 727 "name": { |
| 728 "description": "The project on which to exec
ute the request. The format is "projects/{project_id_or_number}".", |
| 729 "location": "path", |
| 730 "pattern": "^projects/[^/]+$", |
| 731 "required": true, |
| 732 "type": "string" |
| 733 }, |
| 734 "pageToken": { |
| 735 "description": "If this field is not empty t
hen 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.", |
| 736 "location": "query", |
| 737 "type": "string" |
| 738 } |
| 739 }, |
| 740 "path": "v3/{+name}/monitoredResourceDescriptors", |
| 741 "response": { |
| 742 "$ref": "ListMonitoredResourceDescriptorsRespons
e" |
| 743 }, |
| 744 "scopes": [ |
| 745 "https://www.googleapis.com/auth/cloud-platform"
, |
| 746 "https://www.googleapis.com/auth/monitoring", |
| 747 "https://www.googleapis.com/auth/monitoring.read
", |
730 "https://www.googleapis.com/auth/monitoring.writ
e" | 748 "https://www.googleapis.com/auth/monitoring.writ
e" |
731 ] | 749 ] |
732 } | 750 } |
733 } | 751 } |
734 } | 752 } |
735 } | 753 } |
736 } | 754 } |
737 }, | 755 }, |
738 "revision": "20160425", | 756 "revision": "20161031", |
739 "rootUrl": "https://monitoring.googleapis.com/", | 757 "rootUrl": "https://monitoring.googleapis.com/", |
740 "schemas": { | 758 "schemas": { |
741 "CreateCollectdTimeSeriesRequest": { | 759 "Metric": { |
742 "description": "The `CreateCollectdTimeSeries` request.", | 760 "description": "A specific metric, identified by specifying values f
or all of the labels of a MetricDescriptor.", |
743 "id": "CreateCollectdTimeSeriesRequest", | 761 "id": "Metric", |
744 "properties": { | 762 "properties": { |
745 "resource": { | 763 "labels": { |
746 "$ref": "MonitoredResource", | 764 "additionalProperties": { |
747 "description": "The monitored resource associated with the t
ime series." | 765 "type": "string" |
| 766 }, |
| 767 "description": "The set of label values that uniquely identi
fy this metric. All labels listed in the MetricDescriptor must be assigned value
s.", |
| 768 "type": "object" |
748 }, | 769 }, |
749 "collectdVersion": { | 770 "type": { |
750 "description": "The version of `collectd` that collected the
data. Example: `\"5.3.0-192.el6\"`.", | 771 "description": "An existing metric type, see google.api.Metr
icDescriptor. For example, custom.googleapis.com/invoice/paid/amount.", |
751 "type": "string" | 772 "type": "string" |
752 }, | |
753 "collectdPayloads": { | |
754 "description": "The `collectd` payloads representing the tim
e series data. You must not include more than a single point for each time serie
s, so no two payloads can have the same values for all of the fields `plugin`, `
plugin_instance`, `type`, and `type_instance`.", | |
755 "items": { | |
756 "$ref": "CollectdPayload" | |
757 }, | |
758 "type": "array" | |
759 } | 773 } |
760 }, | 774 }, |
761 "type": "object" | 775 "type": "object" |
762 }, | 776 }, |
763 "MonitoredResource": { | 777 "ListGroupMembersResponse": { |
764 "description": "An object representing a resource that can be used f
or monitoring, logging, billing, or other purposes. Examples include virtual mac
hine instances, databases, and storage devices such as disks. The `type` field i
dentifies a MonitoredResourceDescriptor object that describes the resource's sch
ema. Information in the `labels` field identifies the actual resource and its at
tributes according to the schema. For example, a particular Compute Engine VM in
stance could be represented by the following object, because the MonitoredResour
ceDescriptor for `\"gce_instance\"` has labels `\"instance_id\"` and `\"zone\"`:
{ \"type\": \"gce_instance\", \"labels\": { \"instance_id\": \"my-instance\", \
"zone\": \"us-central1-a\" }}", | 778 "description": "The ListGroupMembers response.", |
765 "id": "MonitoredResource", | 779 "id": "ListGroupMembersResponse", |
766 "properties": { | 780 "properties": { |
767 "type": { | 781 "members": { |
768 "description": "Required. The monitored resource type. This
field must match the `type` field of a MonitoredResourceDescriptor object. For e
xample, the type of a Cloud SQL database is `\"cloudsql_database\"`.", | 782 "description": "A set of monitored resources in the group.", |
| 783 "items": { |
| 784 "$ref": "MonitoredResource" |
| 785 }, |
| 786 "type": "array" |
| 787 }, |
| 788 "nextPageToken": { |
| 789 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as pageToken in the next call to this method.", |
769 "type": "string" | 790 "type": "string" |
770 }, | 791 }, |
771 "labels": { | 792 "totalSize": { |
772 "additionalProperties": { | 793 "description": "The total number of elements matching this r
equest.", |
773 "type": "string" | 794 "format": "int32", |
774 }, | 795 "type": "integer" |
775 "description": "Required. Values for all of the labels liste
d in the associated monitored resource descriptor. For example, Cloud SQL databa
ses use the labels `\"database_id\"` and `\"zone\"`.", | |
776 "type": "object" | |
777 } | 796 } |
778 }, | 797 }, |
779 "type": "object" | 798 "type": "object" |
780 }, | 799 }, |
781 "CollectdPayload": { | 800 "TimeInterval": { |
782 "description": "A collection of data points sent from a `collectd`-b
ased plugin. See the `collectd` documentation for more information.", | 801 "description": "A time interval extending just after a start time th
rough an end time. If the start time is the same as the end time, then the inter
val represents a single point in time.", |
783 "id": "CollectdPayload", | 802 "id": "TimeInterval", |
784 "properties": { | 803 "properties": { |
785 "values": { | 804 "endTime": { |
786 "description": "The measured values during this time interva
l. Each value must have a different `dataSourceName`.", | 805 "description": "Required. The end of the time interval.", |
| 806 "format": "google-datetime", |
| 807 "type": "string" |
| 808 }, |
| 809 "startTime": { |
| 810 "description": "Optional. The beginning of the time interval
. The default value for the start time is the end time. The start time must not
be later than the end time.", |
| 811 "format": "google-datetime", |
| 812 "type": "string" |
| 813 } |
| 814 }, |
| 815 "type": "object" |
| 816 }, |
| 817 "Group": { |
| 818 "description": "The description of a dynamic collection of monitored
resources. Each group has a filter that is matched against monitored resources
and their associated metadata. If a group's filter matches an available monitore
d resource, then that resource is a member of that group. Groups can contain any
number of monitored resources, and each monitored resource can be a member of a
ny number of groups.Groups can be nested in parent-child hierarchies. The parent
Name field identifies an optional parent for each group. If a group has a parent
, then the only monitored resources available to be matched by the group's filte
r are the resources contained in the parent group. In other words, a group conta
ins the monitored resources that match its filter and the filters of all the gro
up's ancestors. A group without a parent can contain any monitored resource.For
example, consider an infrastructure running a set of instances with two user-def
ined tags: "environment" and "role". A parent group has a fi
lter, environment="production". A child of that parent group has a fil
ter, role="transcoder". The parent group contains all instances in the
production environment, regardless of their roles. The child group contains ins
tances that have the transcoder role and are in the production environment.The m
onitored resources contained in a group can change at any moment, depending on w
hat resources exist and what filters are associated with the group and its ances
tors.", |
| 819 "id": "Group", |
| 820 "properties": { |
| 821 "displayName": { |
| 822 "description": "A user-assigned name for this group, used on
ly for display purposes.", |
| 823 "type": "string" |
| 824 }, |
| 825 "parentName": { |
| 826 "description": "The name of the group's parent, if it has on
e. The format is "projects/{project_id_or_number}/groups/{group_id}".
For groups with no parent, parentName is the empty string, "".", |
| 827 "type": "string" |
| 828 }, |
| 829 "isCluster": { |
| 830 "description": "If true, the members of this group are consi
dered to be a cluster. The system can perform additional analysis on groups that
are clusters.", |
| 831 "type": "boolean" |
| 832 }, |
| 833 "filter": { |
| 834 "description": "The filter used to determine which monitored
resources belong to this group.", |
| 835 "type": "string" |
| 836 }, |
| 837 "name": { |
| 838 "description": "Output only. The name of this group. The for
mat is "projects/{project_id_or_number}/groups/{group_id}". When creat
ing a group, this field is ignored and a new name is created consisting of the p
roject specified in the call to CreateGroup and a unique {group_id} that is gene
rated automatically.", |
| 839 "type": "string" |
| 840 } |
| 841 }, |
| 842 "type": "object" |
| 843 }, |
| 844 "ListTimeSeriesResponse": { |
| 845 "description": "The ListTimeSeries response.", |
| 846 "id": "ListTimeSeriesResponse", |
| 847 "properties": { |
| 848 "timeSeries": { |
| 849 "description": "One or more time series that match the filte
r included in the request.", |
787 "items": { | 850 "items": { |
788 "$ref": "CollectdValue" | 851 "$ref": "TimeSeries" |
789 }, | 852 }, |
790 "type": "array" | 853 "type": "array" |
791 }, | 854 }, |
792 "startTime": { | 855 "nextPageToken": { |
793 "description": "The start time of the interval.", | 856 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as pageToken in the next call to this method.", |
794 "type": "string" | 857 "type": "string" |
| 858 } |
| 859 }, |
| 860 "type": "object" |
| 861 }, |
| 862 "Point": { |
| 863 "description": "A single data point in a time series.", |
| 864 "id": "Point", |
| 865 "properties": { |
| 866 "value": { |
| 867 "$ref": "TypedValue", |
| 868 "description": "The value of the data point." |
795 }, | 869 }, |
796 "endTime": { | 870 "interval": { |
797 "description": "The end time of the interval.", | 871 "$ref": "TimeInterval", |
798 "type": "string" | 872 "description": "The time interval to which the data point ap
plies. For GAUGE metrics, only the end time of the interval is used. For DELTA m
etrics, the start and end time should specify a non-zero interval, with subseque
nt points specifying contiguous and non-overlapping intervals. For CUMULATIVE me
trics, the start and end time should specify a non-zero interval, with subsequen
t points specifying the same start time and increasing end times, until an event
resets the cumulative value to zero and sets a new start time for the following
points." |
799 }, | |
800 "plugin": { | |
801 "description": "The name of the plugin. Example: `\"disk\"`.
", | |
802 "type": "string" | |
803 }, | |
804 "pluginInstance": { | |
805 "description": "The instance name of the plugin Example: `\"
hdcl\"`.", | |
806 "type": "string" | |
807 }, | |
808 "type": { | |
809 "description": "The measurement type. Example: `\"memory\"`.
", | |
810 "type": "string" | |
811 }, | |
812 "typeInstance": { | |
813 "description": "The measurement type instance. Example: `\"u
sed\"`.", | |
814 "type": "string" | |
815 }, | |
816 "metadata": { | |
817 "additionalProperties": { | |
818 "$ref": "TypedValue" | |
819 }, | |
820 "description": "The measurement metadata. Example: `\"proces
s_id\" -> 12345`", | |
821 "type": "object" | |
822 } | 873 } |
823 }, | 874 }, |
824 "type": "object" | 875 "type": "object" |
825 }, | 876 }, |
826 "CollectdValue": { | 877 "CollectdValue": { |
827 "description": "A single data point from a `collectd`-based plugin."
, | 878 "description": "A single data point from a collectd-based plugin.", |
828 "id": "CollectdValue", | 879 "id": "CollectdValue", |
829 "properties": { | 880 "properties": { |
| 881 "value": { |
| 882 "$ref": "TypedValue", |
| 883 "description": "The measurement value." |
| 884 }, |
830 "dataSourceName": { | 885 "dataSourceName": { |
831 "description": "The data source for the `collectd` value. Fo
r example there are two data sources for network measurements: `\"rx\"` and `\"t
x\"`.", | 886 "description": "The data source for the collectd value. For
example there are two data sources for network measurements: "rx" and
"tx".", |
832 "type": "string" | 887 "type": "string" |
833 }, | 888 }, |
834 "dataSourceType": { | 889 "dataSourceType": { |
835 "description": "The type of measurement.", | 890 "description": "The type of measurement.", |
836 "enum": [ | 891 "enum": [ |
837 "UNSPECIFIED_DATA_SOURCE_TYPE", | 892 "UNSPECIFIED_DATA_SOURCE_TYPE", |
838 "GAUGE", | 893 "GAUGE", |
839 "COUNTER", | 894 "COUNTER", |
840 "DERIVE", | 895 "DERIVE", |
841 "ABSOLUTE" | 896 "ABSOLUTE" |
842 ], | 897 ], |
| 898 "enumDescriptions": [ |
| 899 "An unspecified data source type. This corresponds to go
ogle.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.", |
| 900 "An instantaneous measurement of a varying quantity. Thi
s corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.", |
| 901 "A cumulative value over time. This corresponds to googl
e.api.MetricDescriptor.MetricKind.CUMULATIVE.", |
| 902 "A rate of change of the measurement.", |
| 903 "An amount of change since the last measurement interval
. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA." |
| 904 ], |
843 "type": "string" | 905 "type": "string" |
844 }, | |
845 "value": { | |
846 "$ref": "TypedValue", | |
847 "description": "The measurement value." | |
848 } | 906 } |
849 }, | 907 }, |
850 "type": "object" | 908 "type": "object" |
851 }, | 909 }, |
852 "TypedValue": { | 910 "TimeSeries": { |
853 "description": "A single strongly-typed value.", | 911 "description": "A collection of data points that describes the time-
varying values of a metric. A time series is identified by a combination of a fu
lly-specified monitored resource and a fully-specified metric. This type is used
for both listing and creating time series.", |
854 "id": "TypedValue", | 912 "id": "TimeSeries", |
855 "properties": { | 913 "properties": { |
856 "boolValue": { | 914 "metric": { |
857 "description": "A Boolean value: `true` or `false`.", | 915 "$ref": "Metric", |
858 "type": "boolean" | 916 "description": "The associated metric. A fully-specified met
ric used to identify the time series." |
859 }, | 917 }, |
860 "int64Value": { | 918 "points": { |
861 "description": "A 64-bit integer. Its range is approximately
±9.2x1018.", | 919 "description": "The data points of this time series. When li
sting time series, the order of the points is specified by the list method.When
creating a time series, this field must contain exactly one point and the point'
s type must be the same as the value type of the associated metric. If the assoc
iated metric's descriptor must be auto-created, then the value type of the descr
iptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or D
ISTRIBUTION.", |
862 "format": "int64", | 920 "items": { |
| 921 "$ref": "Point" |
| 922 }, |
| 923 "type": "array" |
| 924 }, |
| 925 "valueType": { |
| 926 "description": "The value type of the time series. When list
ing time series, this value type might be different from the value type of the a
ssociated metric if this time series is an alignment or reduction of other time
series.When creating a time series, this field is optional. If present, it must
be the same as the type of the data in the points field.", |
| 927 "enum": [ |
| 928 "VALUE_TYPE_UNSPECIFIED", |
| 929 "BOOL", |
| 930 "INT64", |
| 931 "DOUBLE", |
| 932 "STRING", |
| 933 "DISTRIBUTION", |
| 934 "MONEY" |
| 935 ], |
| 936 "enumDescriptions": [ |
| 937 "Do not use this default value.", |
| 938 "The value is a boolean. This value type can be used onl
y if the metric kind is GAUGE.", |
| 939 "The value is a signed 64-bit integer.", |
| 940 "The value is a double precision floating point number."
, |
| 941 "The value is a text string. This value type can be used
only if the metric kind is GAUGE.", |
| 942 "The value is a Distribution.", |
| 943 "The value is money." |
| 944 ], |
863 "type": "string" | 945 "type": "string" |
864 }, | 946 }, |
865 "doubleValue": { | 947 "resource": { |
866 "description": "A 64-bit double-precision floating-point num
ber. Its magnitude is approximately ±10±300 and it has 16 significant digits of
precision.", | 948 "$ref": "MonitoredResource", |
867 "format": "double", | 949 "description": "The associated resource. A fully-specified m
onitored resource used to identify the time series." |
868 "type": "number" | |
869 }, | 950 }, |
870 "stringValue": { | 951 "metricKind": { |
871 "description": "A variable-length string value.", | 952 "description": "The metric kind of the time series. When lis
ting time series, this metric kind might be different from the metric kind of th
e associated metric if this time series is an alignment or reduction of other ti
me series.When creating a time series, this field is optional. If present, it mu
st be the same as the metric kind of the associated metric. If the associated me
tric's descriptor must be auto-created, then this field specifies the metric kin
d of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.", |
| 953 "enum": [ |
| 954 "METRIC_KIND_UNSPECIFIED", |
| 955 "GAUGE", |
| 956 "DELTA", |
| 957 "CUMULATIVE" |
| 958 ], |
| 959 "enumDescriptions": [ |
| 960 "Do not use this default value.", |
| 961 "An instantaneous measurement of a value.", |
| 962 "The change in a value during a time interval.", |
| 963 "A value accumulated over a time interval. Cumulative me
asurements in a time series should have the same start time and increasing end t
imes, until an event resets the cumulative value to zero and sets a new start ti
me for the following points." |
| 964 ], |
872 "type": "string" | 965 "type": "string" |
873 }, | |
874 "distributionValue": { | |
875 "$ref": "Distribution", | |
876 "description": "A distribution value." | |
877 } | 966 } |
878 }, | 967 }, |
879 "type": "object" | 968 "type": "object" |
880 }, | 969 }, |
881 "Distribution": { | 970 "MetricDescriptor": { |
882 "description": "Distribution contains summary statistics for a popul
ation of values and, optionally, a histogram representing the distribution of th
ose values across a specified set of histogram buckets. The summary statistics a
re the count, mean, sum of the squared deviation from the mean, the minimum, and
the maximum of the set of population of values. The histogram is based on a seq
uence of buckets and gives a count of values that fall into each bucket. The bou
ndaries of the buckets are given either explicitly or by specifying parameters f
or a method of computing them (buckets of fixed width or buckets of exponentiall
y increasing width). Although it is not forbidden, it is generally a bad idea to
include non-finite values (infinities or NaNs) in the population of values, as
this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", | 971 "description": "Defines a metric type and its schema. Once a metric
descriptor is created, deleting or altering it stops data collection and makes t
he metric type's existing data unusable.", |
883 "id": "Distribution", | 972 "id": "MetricDescriptor", |
884 "properties": { | 973 "properties": { |
885 "count": { | 974 "description": { |
886 "description": "The number of values in the population. Must
be non-negative.", | 975 "description": "A detailed description of the metric, which
can be used in documentation.", |
887 "format": "int64", | |
888 "type": "string" | 976 "type": "string" |
889 }, | 977 }, |
890 "mean": { | 978 "unit": { |
891 "description": "The arithmetic mean of the values in the pop
ulation. If `count` is zero then this field must be zero.", | 979 "description": "The unit in which the metric value is report
ed. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. T
he supported units are a subset of The Unified Code for Units of Measure (http:/
/unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns
second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**
6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (1
0**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np
pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto
(10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)Gr
ammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also
includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. mul
tiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follo
ws:\nExpression = Component { "." Component } { "/" Componen
t } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n
| "1"\n ;\n\nAnnotation = "{" NAME "}&q
uot; ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equiva
lent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitte
d}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not c
ontaining '{' or '}'.", |
| 980 "type": "string" |
| 981 }, |
| 982 "labels": { |
| 983 "description": "The set of labels that can be used to descri
be a specific instance of this metric type. For example, the appengine.googleapi
s.com/http/server/response_latencies metric type has a label for the HTTP respon
se code, response_code, so you can look at latencies for successful responses or
just for responses that failed.", |
| 984 "items": { |
| 985 "$ref": "LabelDescriptor" |
| 986 }, |
| 987 "type": "array" |
| 988 }, |
| 989 "metricKind": { |
| 990 "description": "Whether the metric records instantaneous val
ues, changes to a value, etc. Some combinations of metric_kind and value_type mi
ght not be supported.", |
| 991 "enum": [ |
| 992 "METRIC_KIND_UNSPECIFIED", |
| 993 "GAUGE", |
| 994 "DELTA", |
| 995 "CUMULATIVE" |
| 996 ], |
| 997 "enumDescriptions": [ |
| 998 "Do not use this default value.", |
| 999 "An instantaneous measurement of a value.", |
| 1000 "The change in a value during a time interval.", |
| 1001 "A value accumulated over a time interval. Cumulative me
asurements in a time series should have the same start time and increasing end t
imes, until an event resets the cumulative value to zero and sets a new start ti
me for the following points." |
| 1002 ], |
| 1003 "type": "string" |
| 1004 }, |
| 1005 "valueType": { |
| 1006 "description": "Whether the measurement is an integer, a flo
ating-point number, etc. Some combinations of metric_kind and value_type might n
ot be supported.", |
| 1007 "enum": [ |
| 1008 "VALUE_TYPE_UNSPECIFIED", |
| 1009 "BOOL", |
| 1010 "INT64", |
| 1011 "DOUBLE", |
| 1012 "STRING", |
| 1013 "DISTRIBUTION", |
| 1014 "MONEY" |
| 1015 ], |
| 1016 "enumDescriptions": [ |
| 1017 "Do not use this default value.", |
| 1018 "The value is a boolean. This value type can be used onl
y if the metric kind is GAUGE.", |
| 1019 "The value is a signed 64-bit integer.", |
| 1020 "The value is a double precision floating point number."
, |
| 1021 "The value is a text string. This value type can be used
only if the metric kind is GAUGE.", |
| 1022 "The value is a Distribution.", |
| 1023 "The value is money." |
| 1024 ], |
| 1025 "type": "string" |
| 1026 }, |
| 1027 "displayName": { |
| 1028 "description": "A concise name for the metric, which can be
displayed in user interfaces. Use sentence case without an ending period, for ex
ample \"Request count\".", |
| 1029 "type": "string" |
| 1030 }, |
| 1031 "name": { |
| 1032 "description": "The resource name of the metric descriptor.
Depending on the implementation, the name typically includes: (1) the parent res
ource name that defines the scope of the metric type or of its data; and (2) the
metric's URL-encoded type, which also appears in the type field of this descrip
tor. For example, following is the resource name of a custom metric within the G
CP project 123456789:\n"projects/123456789/metricDescriptors/custom.googlea
pis.com%2Finvoice%2Fpaid%2Famount"\n", |
| 1033 "type": "string" |
| 1034 }, |
| 1035 "type": { |
| 1036 "description": "The metric type, including its DNS name pref
ix. The type is not URL-encoded. All user-defined metric types have the DNS name
custom.googleapis.com. Metric types should use a natural hierarchical grouping.
For example:\n"custom.googleapis.com/invoice/paid/amount"\n"appe
ngine.googleapis.com/http/server/response_latencies"\n", |
| 1037 "type": "string" |
| 1038 } |
| 1039 }, |
| 1040 "type": "object" |
| 1041 }, |
| 1042 "Exponential": { |
| 1043 "description": "Specify a sequence of buckets that have a width that
is proportional to the value of the lower bound. Each bucket represents a const
ant relative uncertainty on a specific value in the bucket.Defines num_finite_bu
ckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <=
i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale
* (growth_factor ^ (i - 1)).", |
| 1044 "id": "Exponential", |
| 1045 "properties": { |
| 1046 "growthFactor": { |
| 1047 "description": "Must be greater than 1.", |
892 "format": "double", | 1048 "format": "double", |
893 "type": "number" | 1049 "type": "number" |
894 }, | 1050 }, |
895 "sumOfSquaredDeviation": { | 1051 "scale": { |
896 "description": "The sum of squared deviations from the mean
of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean
)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition d
escribes Welford's method for accumulating this sum in one pass. If `count` is z
ero then this field must be zero.", | 1052 "description": "Must be greater than 0.", |
897 "format": "double", | 1053 "format": "double", |
898 "type": "number" | 1054 "type": "number" |
899 }, | 1055 }, |
900 "range": { | 1056 "numFiniteBuckets": { |
901 "$ref": "Range", | 1057 "description": "Must be greater than 0.", |
902 "description": "If specified, contains the range of the popu
lation values. The field must not be present if the `count` is zero." | 1058 "format": "int32", |
903 }, | 1059 "type": "integer" |
904 "bucketOptions": { | 1060 } |
905 "$ref": "BucketOptions", | 1061 }, |
906 "description": "Defines the histogram bucket boundaries." | 1062 "type": "object" |
907 }, | 1063 }, |
908 "bucketCounts": { | 1064 "Explicit": { |
909 "description": "If `bucket_options` is given, then the sum o
f the values in `bucket_counts` must equal the value in `count`. If `bucket_opti
ons` is not given, no `bucket_counts` fields may be given. Bucket counts are giv
en in order under the numbering scheme described above (the underflow bucket has
number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow
bucket has number N-1). The size of `bucket_counts` must be no greater than N as
defined in `bucket_options`. Any suffix of trailing zero bucket_count fields ma
y be omitted.", | 1065 "description": "A set of buckets with arbitrary widths.Defines size(
bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <
= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1There must be
at least one element in bounds. If bounds has only one element, there are no fi
nite buckets, and that single element is the common boundary of the overflow and
underflow buckets.", |
| 1066 "id": "Explicit", |
| 1067 "properties": { |
| 1068 "bounds": { |
| 1069 "description": "The values must be monotonically increasing.
", |
910 "items": { | 1070 "items": { |
911 "format": "int64", | 1071 "format": "double", |
912 "type": "string" | 1072 "type": "number" |
913 }, | 1073 }, |
914 "type": "array" | 1074 "type": "array" |
915 } | 1075 } |
916 }, | 1076 }, |
917 "type": "object" | 1077 "type": "object" |
918 }, | 1078 }, |
919 "Range": { | |
920 "description": "The range of the population values.", | |
921 "id": "Range", | |
922 "properties": { | |
923 "min": { | |
924 "description": "The minimum of the population values.", | |
925 "format": "double", | |
926 "type": "number" | |
927 }, | |
928 "max": { | |
929 "description": "The maximum of the population values.", | |
930 "format": "double", | |
931 "type": "number" | |
932 } | |
933 }, | |
934 "type": "object" | |
935 }, | |
936 "BucketOptions": { | |
937 "description": "A Distribution may optionally contain a histogram of
the values in the population. The histogram is given in `bucket_counts` as coun
ts of values that fall into one of a sequence of non-overlapping buckets. The se
quence of buckets is described by `bucket_options`. A bucket specifies an inclus
ive lower bound and exclusive upper bound for the values that are counted for th
at bucket. The upper bound of a bucket is strictly greater than the lower bound.
The sequence of N buckets for a Distribution consists of an underflow bucket (n
umber 0), zero or more finite buckets (number 1 through N - 2) and an overflow b
ucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i
> 0) is the same as the upper bound of bucket i - 1. The buckets span the whole
range of finite values: lower bound of the underflow bucket is -infinity and th
e upper bound of the overflow bucket is +infinity. The finite buckets are so-cal
led because both bounds are finite. `BucketOptions` describes bucket boundaries
in one of three ways. Two describe the boundaries by giving parameters for a for
mula to generate boundaries and one gives the bucket boundaries explicitly. If `
bucket_boundaries` is not given, then no `bucket_counts` may be given.", | |
938 "id": "BucketOptions", | |
939 "properties": { | |
940 "linearBuckets": { | |
941 "$ref": "Linear", | |
942 "description": "The linear bucket." | |
943 }, | |
944 "exponentialBuckets": { | |
945 "$ref": "Exponential", | |
946 "description": "The exponential buckets." | |
947 }, | |
948 "explicitBuckets": { | |
949 "$ref": "Explicit", | |
950 "description": "The explicit buckets." | |
951 } | |
952 }, | |
953 "type": "object" | |
954 }, | |
955 "Linear": { | 1079 "Linear": { |
956 "description": "Specify a sequence of buckets that all have the same
width (except overflow and underflow). Each bucket represents a constant absolu
te uncertainty on the specific value in the bucket. Defines `num_finite_buckets
+ 2` (= N) buckets with these boundaries for bucket `i`: Upper bound (0 <= i < N
-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
", | 1080 "description": "Specify a sequence of buckets that all have the same
width (except overflow and underflow). Each bucket represents a constant absolu
te uncertainty on the specific value in the bucket.Defines num_finite_buckets +
2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N
-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i
- 1)).", |
957 "id": "Linear", | 1081 "id": "Linear", |
958 "properties": { | 1082 "properties": { |
959 "numFiniteBuckets": { | |
960 "description": "Must be greater than 0.", | |
961 "format": "int32", | |
962 "type": "integer" | |
963 }, | |
964 "width": { | 1083 "width": { |
965 "description": "Must be greater than 0.", | 1084 "description": "Must be greater than 0.", |
966 "format": "double", | 1085 "format": "double", |
967 "type": "number" | 1086 "type": "number" |
968 }, | 1087 }, |
969 "offset": { | 1088 "offset": { |
970 "description": "Lower bound of the first bucket.", | 1089 "description": "Lower bound of the first bucket.", |
971 "format": "double", | 1090 "format": "double", |
972 "type": "number" | 1091 "type": "number" |
973 } | 1092 }, |
974 }, | |
975 "type": "object" | |
976 }, | |
977 "Exponential": { | |
978 "description": "Specify a sequence of buckets that have a width that
is proportional to the value of the lower bound. Each bucket represents a const
ant relative uncertainty on a specific value in the bucket. Defines `num_finite_
buckets + 2` (= N) buckets with these boundaries for bucket i: Upper bound (0 <=
i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growt
h_factor ^ (i - 1)).", | |
979 "id": "Exponential", | |
980 "properties": { | |
981 "numFiniteBuckets": { | 1093 "numFiniteBuckets": { |
982 "description": "must be greater than 0", | 1094 "description": "Must be greater than 0.", |
983 "format": "int32", | |
984 "type": "integer" | |
985 }, | |
986 "growthFactor": { | |
987 "description": "Must be greater than 1", | |
988 "format": "double", | |
989 "type": "number" | |
990 }, | |
991 "scale": { | |
992 "description": "Must be greater than 0", | |
993 "format": "double", | |
994 "type": "number" | |
995 } | |
996 }, | |
997 "type": "object" | |
998 }, | |
999 "Explicit": { | |
1000 "description": "A set of buckets with arbitrary widths. Defines `siz
e(bounds) + 1` (= N) buckets with these boundaries for bucket i: Upper bound (0
<= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] There must be at
least one element in `bounds`. If `bounds` has only one element, there are no fi
nite buckets, and that single element is the common boundary of the overflow and
underflow buckets.", | |
1001 "id": "Explicit", | |
1002 "properties": { | |
1003 "bounds": { | |
1004 "description": "The values must be monotonically increasing.
", | |
1005 "items": { | |
1006 "format": "double", | |
1007 "type": "number" | |
1008 }, | |
1009 "type": "array" | |
1010 } | |
1011 }, | |
1012 "type": "object" | |
1013 }, | |
1014 "Empty": { | |
1015 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", | |
1016 "id": "Empty", | |
1017 "type": "object" | |
1018 }, | |
1019 "ListGroupsResponse": { | |
1020 "description": "The `ListGroups` response.", | |
1021 "id": "ListGroupsResponse", | |
1022 "properties": { | |
1023 "group": { | |
1024 "description": "The groups that match the specified filters.
", | |
1025 "items": { | |
1026 "$ref": "Group" | |
1027 }, | |
1028 "type": "array" | |
1029 }, | |
1030 "nextPageToken": { | |
1031 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as `pageToken` in the next call to this method.", | |
1032 "type": "string" | |
1033 } | |
1034 }, | |
1035 "type": "object" | |
1036 }, | |
1037 "Group": { | |
1038 "description": "The description of a dynamic collection of monitored
resources. Each group has a filter that is matched against monitored resources
and their associated metadata. If a group's filter matches an available monitore
d resource, then that resource is a member of that group. Groups can contain any
number of monitored resources, and each monitored resource can be a member of a
ny number of groups. Groups can be nested in parent-child hierarchies. The `pare
ntName` field identifies an optional parent for each group. If a group has a par
ent, then the only monitored resources available to be matched by the group's fi
lter are the resources contained in the parent group. In other words, a group co
ntains the monitored resources that match its filter and the filters of all the
group's ancestors. A group without a parent can contain any monitored resource.
For example, consider an infrastructure running a set of instances with two user
-defined tags: `\"environment\"` and `\"role\"`. A parent group has a filter, `e
nvironment=\"production\"`. A child of that parent group has a filter, `role=\"t
ranscoder\"`. The parent group contains all instances in the production environm
ent, regardless of their roles. The child group contains instances that have the
transcoder role *and* are in the production environment. The monitored resource
s contained in a group can change at any moment, depending on what resources exi
st and what filters are associated with the group and its ancestors.", | |
1039 "id": "Group", | |
1040 "properties": { | |
1041 "name": { | |
1042 "description": "The name of this group. The format is `\"pro
jects/{project_id_or_number}/groups/{group_id}\"`. When creating a group, this f
ield is ignored and a new name is created consisting of the project specified in
the call to `CreateGroup` and a unique `{group_id}` that is generated automatic
ally. @OutputOnly", | |
1043 "type": "string" | |
1044 }, | |
1045 "displayName": { | |
1046 "description": "A user-assigned name for this group, used on
ly for display purposes.", | |
1047 "type": "string" | |
1048 }, | |
1049 "parentName": { | |
1050 "description": "The name of the group's parent, if it has on
e. The format is `\"projects/{project_id_or_number}/groups/{group_id}\"`. For gr
oups with no parent, `parentName` is the empty string, `\"\"`.", | |
1051 "type": "string" | |
1052 }, | |
1053 "filter": { | |
1054 "description": "The filter used to determine which monitored
resources belong to this group.", | |
1055 "type": "string" | |
1056 }, | |
1057 "isCluster": { | |
1058 "description": "If true, the members of this group are consi
dered to be a cluster. The system can perform additional analysis on groups that
are clusters.", | |
1059 "type": "boolean" | |
1060 } | |
1061 }, | |
1062 "type": "object" | |
1063 }, | |
1064 "ListGroupMembersResponse": { | |
1065 "description": "The `ListGroupMembers` response.", | |
1066 "id": "ListGroupMembersResponse", | |
1067 "properties": { | |
1068 "members": { | |
1069 "description": "A set of monitored resources in the group.", | |
1070 "items": { | |
1071 "$ref": "MonitoredResource" | |
1072 }, | |
1073 "type": "array" | |
1074 }, | |
1075 "nextPageToken": { | |
1076 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as `pageToken` in the next call to this method.", | |
1077 "type": "string" | |
1078 }, | |
1079 "totalSize": { | |
1080 "description": "The total number of elements matching this r
equest.", | |
1081 "format": "int32", | 1095 "format": "int32", |
1082 "type": "integer" | 1096 "type": "integer" |
1083 } | 1097 } |
1084 }, | 1098 }, |
1085 "type": "object" | 1099 "type": "object" |
1086 }, | 1100 }, |
1087 "ListMonitoredResourceDescriptorsResponse": { | 1101 "CollectdPayload": { |
1088 "description": "The `ListMonitoredResourcDescriptors` response.", | 1102 "description": "A collection of data points sent from a collectd-bas
ed plugin. See the collectd documentation for more information.", |
1089 "id": "ListMonitoredResourceDescriptorsResponse", | 1103 "id": "CollectdPayload", |
1090 "properties": { | 1104 "properties": { |
1091 "resourceDescriptors": { | 1105 "endTime": { |
1092 "description": "The monitored resource descriptors that are
available to this project and that match `filter`, if present.", | 1106 "description": "The end time of the interval.", |
| 1107 "format": "google-datetime", |
| 1108 "type": "string" |
| 1109 }, |
| 1110 "metadata": { |
| 1111 "additionalProperties": { |
| 1112 "$ref": "TypedValue" |
| 1113 }, |
| 1114 "description": "The measurement metadata. Example: "pro
cess_id" -> 12345", |
| 1115 "type": "object" |
| 1116 }, |
| 1117 "values": { |
| 1118 "description": "The measured values during this time interva
l. Each value must have a different dataSourceName.", |
1093 "items": { | 1119 "items": { |
1094 "$ref": "MonitoredResourceDescriptor" | 1120 "$ref": "CollectdValue" |
1095 }, | 1121 }, |
1096 "type": "array" | 1122 "type": "array" |
1097 }, | 1123 }, |
1098 "nextPageToken": { | 1124 "pluginInstance": { |
1099 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as `pageToken` in the next call to this method.", | 1125 "description": "The instance name of the plugin Example: &qu
ot;hdcl".", |
| 1126 "type": "string" |
| 1127 }, |
| 1128 "startTime": { |
| 1129 "description": "The start time of the interval.", |
| 1130 "format": "google-datetime", |
| 1131 "type": "string" |
| 1132 }, |
| 1133 "typeInstance": { |
| 1134 "description": "The measurement type instance. Example: &quo
t;used".", |
| 1135 "type": "string" |
| 1136 }, |
| 1137 "type": { |
| 1138 "description": "The measurement type. Example: "memory&
quot;.", |
| 1139 "type": "string" |
| 1140 }, |
| 1141 "plugin": { |
| 1142 "description": "The name of the plugin. Example: "disk&
quot;.", |
1100 "type": "string" | 1143 "type": "string" |
1101 } | 1144 } |
1102 }, | 1145 }, |
1103 "type": "object" | 1146 "type": "object" |
1104 }, | 1147 }, |
1105 "MonitoredResourceDescriptor": { | 1148 "ListMetricDescriptorsResponse": { |
1106 "description": "An object that describes the schema of a MonitoredRe
source object using a type name and a set of labels. For example, the monitored
resource descriptor for Google Compute Engine VM instances has a type of `\"gce_
instance\"` and specifies the use of the labels `\"instance_id\"` and `\"zone\"`
to identify particular VM instances. Different APIs can support different monit
ored resource types. APIs generally provide a `list` method that returns the mon
itored resource descriptors used by the API.", | 1149 "description": "The ListMetricDescriptors response.", |
1107 "id": "MonitoredResourceDescriptor", | 1150 "id": "ListMetricDescriptorsResponse", |
1108 "properties": { | 1151 "properties": { |
1109 "name": { | 1152 "metricDescriptors": { |
1110 "description": "Optional. The resource name of the monitored
resource descriptor: `\"projects/{project_id}/monitoredResourceDescriptors/{typ
e}\"` where {type} is the value of the `type` field in this object and {project_
id} is a project ID that provides API-specific context for accessing the type. A
PIs that do not use project information can use the resource name format `\"moni
toredResourceDescriptors/{type}\"`.", | 1153 "description": "The metric descriptors that are available to
the project and that match the value of filter, if present.", |
1111 "type": "string" | |
1112 }, | |
1113 "type": { | |
1114 "description": "Required. The monitored resource type. For e
xample, the type `\"cloudsql_database\"` represents databases in Google Cloud SQ
L.", | |
1115 "type": "string" | |
1116 }, | |
1117 "displayName": { | |
1118 "description": "Optional. A concise name for the monitored r
esource type that might be displayed in user interfaces. For example, `\"Google
Cloud SQL Database\"`.", | |
1119 "type": "string" | |
1120 }, | |
1121 "description": { | |
1122 "description": "Optional. A detailed description of the moni
tored resource type that might be used in documentation.", | |
1123 "type": "string" | |
1124 }, | |
1125 "labels": { | |
1126 "description": "Required. A set of labels used to describe i
nstances of this monitored resource type. For example, an individual Google Clou
d SQL database is identified by values for the labels `\"database_id\"` and `\"z
one\"`.", | |
1127 "items": { | 1154 "items": { |
1128 "$ref": "LabelDescriptor" | 1155 "$ref": "MetricDescriptor" |
1129 }, | 1156 }, |
1130 "type": "array" | 1157 "type": "array" |
| 1158 }, |
| 1159 "nextPageToken": { |
| 1160 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as pageToken in the next call to this method.", |
| 1161 "type": "string" |
1131 } | 1162 } |
1132 }, | 1163 }, |
1133 "type": "object" | 1164 "type": "object" |
| 1165 }, |
| 1166 "Distribution": { |
| 1167 "description": "Distribution contains summary statistics for a popul
ation of values and, optionally, a histogram representing the distribution of th
ose values across a specified set of histogram buckets.The summary statistics ar
e the count, mean, sum of the squared deviation from the mean, the minimum, and
the maximum of the set of population of values.The histogram is based on a seque
nce of buckets and gives a count of values that fall into each bucket. The bound
aries of the buckets are given either explicitly or by specifying parameters for
a method of computing them (buckets of fixed width or buckets of exponentially
increasing width).Although it is not forbidden, it is generally a bad idea to in
clude non-finite values (infinities or NaNs) in the population of values, as thi
s will render the mean and sum_of_squared_deviation fields meaningless.", |
| 1168 "id": "Distribution", |
| 1169 "properties": { |
| 1170 "bucketCounts": { |
| 1171 "description": "If bucket_options is given, then the sum of
the values in bucket_counts must equal the value in count. If bucket_options is
not given, no bucket_counts fields may be given.Bucket counts are given in order
under the numbering scheme described above (the underflow bucket has number 0;
the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has
number N-1).The size of bucket_counts must be no greater than N as defined in bu
cket_options.Any suffix of trailing zero bucket_count fields may be omitted.", |
| 1172 "items": { |
| 1173 "format": "int64", |
| 1174 "type": "string" |
| 1175 }, |
| 1176 "type": "array" |
| 1177 }, |
| 1178 "bucketOptions": { |
| 1179 "$ref": "BucketOptions", |
| 1180 "description": "Defines the histogram bucket boundaries." |
| 1181 }, |
| 1182 "count": { |
| 1183 "description": "The number of values in the population. Must
be non-negative.", |
| 1184 "format": "int64", |
| 1185 "type": "string" |
| 1186 }, |
| 1187 "sumOfSquaredDeviation": { |
| 1188 "description": "The sum of squared deviations from the mean
of the values in the population. For values x_i this is:\nSum[i=1..n]((x_i - mea
n)^2)\nKnuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition
describes Welford's method for accumulating this sum in one pass.If count is ze
ro then this field must be zero.", |
| 1189 "format": "double", |
| 1190 "type": "number" |
| 1191 }, |
| 1192 "mean": { |
| 1193 "description": "The arithmetic mean of the values in the pop
ulation. If count is zero then this field must be zero.", |
| 1194 "format": "double", |
| 1195 "type": "number" |
| 1196 }, |
| 1197 "range": { |
| 1198 "$ref": "Range", |
| 1199 "description": "If specified, contains the range of the popu
lation values. The field must not be present if the count is zero. This field is
presently ignored by the Stackdriver Monitoring API v3." |
| 1200 } |
| 1201 }, |
| 1202 "type": "object" |
| 1203 }, |
| 1204 "MonitoredResource": { |
| 1205 "description": "An object representing a resource that can be used f
or monitoring, logging, billing, or other purposes. Examples include virtual mac
hine instances, databases, and storage devices such as disks. The type field ide
ntifies a MonitoredResourceDescriptor object that describes the resource's schem
a. Information in the labels field identifies the actual resource and its attrib
utes according to the schema. For example, a particular Compute Engine VM instan
ce could be represented by the following object, because the MonitoredResourceDe
scriptor for "gce_instance" has labels "instance_id" and &qu
ot;zone":\n{ "type": "gce_instance",\n "labels&qu
ot;: { "instance_id": "12345678901234",\n "
;zone": "us-central1-a" }}\n", |
| 1206 "id": "MonitoredResource", |
| 1207 "properties": { |
| 1208 "labels": { |
| 1209 "additionalProperties": { |
| 1210 "type": "string" |
| 1211 }, |
| 1212 "description": "Required. Values for all of the labels liste
d in the associated monitored resource descriptor. For example, Cloud SQL databa
ses use the labels "database_id" and "zone".", |
| 1213 "type": "object" |
| 1214 }, |
| 1215 "type": { |
| 1216 "description": "Required. The monitored resource type. This
field must match the type field of a MonitoredResourceDescriptor object. For exa
mple, the type of a Cloud SQL database is "cloudsql_database".", |
| 1217 "type": "string" |
| 1218 } |
| 1219 }, |
| 1220 "type": "object" |
1134 }, | 1221 }, |
1135 "LabelDescriptor": { | 1222 "LabelDescriptor": { |
1136 "description": "A description of a label.", | 1223 "description": "A description of a label.", |
1137 "id": "LabelDescriptor", | 1224 "id": "LabelDescriptor", |
1138 "properties": { | 1225 "properties": { |
1139 "key": { | 1226 "description": { |
1140 "description": "The label key.", | 1227 "description": "A human-readable description for the label."
, |
1141 "type": "string" | 1228 "type": "string" |
1142 }, | 1229 }, |
1143 "valueType": { | 1230 "valueType": { |
1144 "description": "The type of data that can be assigned to the
label.", | 1231 "description": "The type of data that can be assigned to the
label.", |
1145 "enum": [ | 1232 "enum": [ |
1146 "STRING", | 1233 "STRING", |
1147 "BOOL", | 1234 "BOOL", |
1148 "INT64" | 1235 "INT64" |
1149 ], | 1236 ], |
| 1237 "enumDescriptions": [ |
| 1238 "A variable-length string. This is the default.", |
| 1239 "Boolean; true or false.", |
| 1240 "A 64-bit signed integer." |
| 1241 ], |
| 1242 "type": "string" |
| 1243 }, |
| 1244 "key": { |
| 1245 "description": "The label key.", |
| 1246 "type": "string" |
| 1247 } |
| 1248 }, |
| 1249 "type": "object" |
| 1250 }, |
| 1251 "MonitoredResourceDescriptor": { |
| 1252 "description": "An object that describes the schema of a MonitoredRe
source object using a type name and a set of labels. For example, the monitored
resource descriptor for Google Compute Engine VM instances has a type of "g
ce_instance" and specifies the use of the labels "instance_id" an
d "zone" to identify particular VM instances.Different APIs can suppor
t different monitored resource types. APIs generally provide a list method that
returns the monitored resource descriptors used by the API.", |
| 1253 "id": "MonitoredResourceDescriptor", |
| 1254 "properties": { |
| 1255 "displayName": { |
| 1256 "description": "Optional. A concise name for the monitored r
esource type that might be displayed in user interfaces. It should be a Title Ca
sed Noun Phrase, without any article or other determiners. For example, "Go
ogle Cloud SQL Database".", |
1150 "type": "string" | 1257 "type": "string" |
1151 }, | 1258 }, |
1152 "description": { | 1259 "description": { |
1153 "description": "A human-readable description for the label."
, | 1260 "description": "Optional. A detailed description of the moni
tored resource type that might be used in documentation.", |
1154 "type": "string" | 1261 "type": "string" |
1155 } | 1262 }, |
1156 }, | 1263 "labels": { |
1157 "type": "object" | 1264 "description": "Required. A set of labels used to describe i
nstances of this monitored resource type. For example, an individual Google Clou
d SQL database is identified by values for the labels "database_id" an
d "zone".", |
1158 }, | 1265 "items": { |
1159 "ListMetricDescriptorsResponse": { | 1266 "$ref": "LabelDescriptor" |
1160 "description": "The `ListMetricDescriptors` response.", | |
1161 "id": "ListMetricDescriptorsResponse", | |
1162 "properties": { | |
1163 "metricDescriptors": { | |
1164 "description": "The metric descriptors that are available to
the project and that match the value of `filter`, if present.", | |
1165 "items": { | |
1166 "$ref": "MetricDescriptor" | |
1167 }, | 1267 }, |
1168 "type": "array" | 1268 "type": "array" |
1169 }, | 1269 }, |
| 1270 "type": { |
| 1271 "description": "Required. The monitored resource type. For e
xample, the type "cloudsql_database" represents databases in Google Cl
oud SQL. The maximum length of this value is 256 characters.", |
| 1272 "type": "string" |
| 1273 }, |
| 1274 "name": { |
| 1275 "description": "Optional. The resource name of the monitored
resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{
type}" where {type} is the value of the type field in this object and {proj
ect_id} is a project ID that provides API-specific context for accessing the typ
e. APIs that do not use project information can use the resource name format &qu
ot;monitoredResourceDescriptors/{type}".", |
| 1276 "type": "string" |
| 1277 } |
| 1278 }, |
| 1279 "type": "object" |
| 1280 }, |
| 1281 "TypedValue": { |
| 1282 "description": "A single strongly-typed value.", |
| 1283 "id": "TypedValue", |
| 1284 "properties": { |
| 1285 "boolValue": { |
| 1286 "description": "A Boolean value: true or false.", |
| 1287 "type": "boolean" |
| 1288 }, |
| 1289 "stringValue": { |
| 1290 "description": "A variable-length string value.", |
| 1291 "type": "string" |
| 1292 }, |
| 1293 "int64Value": { |
| 1294 "description": "A 64-bit integer. Its range is approximately
±9.2x10<sup>18</sup>.", |
| 1295 "format": "int64", |
| 1296 "type": "string" |
| 1297 }, |
| 1298 "doubleValue": { |
| 1299 "description": "A 64-bit double-precision floating-point num
ber. Its magnitude is approximately ±10<sup>±300</sup> and it has
16 significant digits of precision.", |
| 1300 "format": "double", |
| 1301 "type": "number" |
| 1302 }, |
| 1303 "distributionValue": { |
| 1304 "$ref": "Distribution", |
| 1305 "description": "A distribution value." |
| 1306 } |
| 1307 }, |
| 1308 "type": "object" |
| 1309 }, |
| 1310 "ListMonitoredResourceDescriptorsResponse": { |
| 1311 "description": "The ListMonitoredResourcDescriptors response.", |
| 1312 "id": "ListMonitoredResourceDescriptorsResponse", |
| 1313 "properties": { |
1170 "nextPageToken": { | 1314 "nextPageToken": { |
1171 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as `pageToken` in the next call to this method.", | 1315 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as pageToken in the next call to this method.", |
1172 "type": "string" | 1316 "type": "string" |
1173 } | 1317 }, |
1174 }, | 1318 "resourceDescriptors": { |
1175 "type": "object" | 1319 "description": "The monitored resource descriptors that are
available to this project and that match filter, if present.", |
1176 }, | 1320 "items": { |
1177 "MetricDescriptor": { | 1321 "$ref": "MonitoredResourceDescriptor" |
1178 "description": "Defines a metric type and its schema.", | 1322 }, |
1179 "id": "MetricDescriptor", | 1323 "type": "array" |
1180 "properties": { | 1324 } |
| 1325 }, |
| 1326 "type": "object" |
| 1327 }, |
| 1328 "Field": { |
| 1329 "description": "A single field of a message type.", |
| 1330 "id": "Field", |
| 1331 "properties": { |
| 1332 "defaultValue": { |
| 1333 "description": "The string value of the default value of thi
s field. Proto2 syntax only.", |
| 1334 "type": "string" |
| 1335 }, |
| 1336 "jsonName": { |
| 1337 "description": "The field JSON name.", |
| 1338 "type": "string" |
| 1339 }, |
| 1340 "options": { |
| 1341 "description": "The protocol buffer options.", |
| 1342 "items": { |
| 1343 "$ref": "Option" |
| 1344 }, |
| 1345 "type": "array" |
| 1346 }, |
| 1347 "oneofIndex": { |
| 1348 "description": "The index of the field type in Type.oneofs,
for message or enumeration types. The first type has index 1; zero means the typ
e is not in the list.", |
| 1349 "format": "int32", |
| 1350 "type": "integer" |
| 1351 }, |
| 1352 "cardinality": { |
| 1353 "description": "The field cardinality.", |
| 1354 "enum": [ |
| 1355 "CARDINALITY_UNKNOWN", |
| 1356 "CARDINALITY_OPTIONAL", |
| 1357 "CARDINALITY_REQUIRED", |
| 1358 "CARDINALITY_REPEATED" |
| 1359 ], |
| 1360 "enumDescriptions": [ |
| 1361 "For fields with unknown cardinality.", |
| 1362 "For optional fields.", |
| 1363 "For required fields. Proto2 syntax only.", |
| 1364 "For repeated fields." |
| 1365 ], |
| 1366 "type": "string" |
| 1367 }, |
| 1368 "typeUrl": { |
| 1369 "description": "The field type URL, without the scheme, for
message or enumeration types. Example: "type.googleapis.com/google.protobuf
.Timestamp".", |
| 1370 "type": "string" |
| 1371 }, |
1181 "name": { | 1372 "name": { |
1182 "description": "Resource name. The format of the name may va
ry between different implementations. For examples: projects/{project_id}/metric
Descriptors/{type=**} metricDescriptors/{type=**}", | 1373 "description": "The field name.", |
1183 "type": "string" | 1374 "type": "string" |
1184 }, | 1375 }, |
1185 "type": { | 1376 "packed": { |
1186 "description": "The metric type including a DNS name prefix,
for example `\"compute.googleapis.com/instance/cpu/utilization\"`. Metric types
should use a natural hierarchical grouping such as the following: compute.googl
eapis.com/instance/cpu/utilization compute.googleapis.com/instance/disk/read_ops
_count compute.googleapis.com/instance/network/received_bytes_count Note that if
the metric type changes, the monitoring data will be discontinued, and anything
depends on it will break, such as monitoring dashboards, alerting rules and quo
ta limits. Therefore, once a metric has been published, its type should be immut
able.", | 1377 "description": "Whether to use alternative packed wire repre
sentation.", |
1187 "type": "string" | 1378 "type": "boolean" |
1188 }, | 1379 }, |
1189 "labels": { | 1380 "number": { |
1190 "description": "The set of labels that can be used to descri
be a specific instance of this metric type. For example, the `compute.googleapis
.com/instance/network/received_bytes_count` metric type has a label, `loadbalanc
ed`, that specifies whether the traffic was received through a load balanced IP
address.", | 1381 "description": "The field number.", |
1191 "items": { | 1382 "format": "int32", |
1192 "$ref": "LabelDescriptor" | 1383 "type": "integer" |
1193 }, | 1384 }, |
1194 "type": "array" | 1385 "kind": { |
1195 }, | 1386 "description": "The field type.", |
1196 "metricKind": { | |
1197 "description": "Whether the metric records instantaneous val
ues, changes to a value, etc.", | |
1198 "enum": [ | 1387 "enum": [ |
1199 "METRIC_KIND_UNSPECIFIED", | 1388 "TYPE_UNKNOWN", |
1200 "GAUGE", | 1389 "TYPE_DOUBLE", |
1201 "DELTA", | 1390 "TYPE_FLOAT", |
1202 "CUMULATIVE" | 1391 "TYPE_INT64", |
1203 ], | 1392 "TYPE_UINT64", |
1204 "type": "string" | 1393 "TYPE_INT32", |
1205 }, | 1394 "TYPE_FIXED64", |
1206 "valueType": { | 1395 "TYPE_FIXED32", |
1207 "description": "Whether the measurement is an integer, a flo
ating-point number, etc.", | 1396 "TYPE_BOOL", |
1208 "enum": [ | 1397 "TYPE_STRING", |
1209 "VALUE_TYPE_UNSPECIFIED", | 1398 "TYPE_GROUP", |
1210 "BOOL", | 1399 "TYPE_MESSAGE", |
1211 "INT64", | 1400 "TYPE_BYTES", |
1212 "DOUBLE", | 1401 "TYPE_UINT32", |
1213 "STRING", | 1402 "TYPE_ENUM", |
1214 "DISTRIBUTION", | 1403 "TYPE_SFIXED32", |
1215 "MONEY" | 1404 "TYPE_SFIXED64", |
1216 ], | 1405 "TYPE_SINT32", |
1217 "type": "string" | 1406 "TYPE_SINT64" |
1218 }, | 1407 ], |
1219 "unit": { | 1408 "enumDescriptions": [ |
1220 "description": "The unit in which the metric value is report
ed. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBU
TION`. The supported units are a subset of [The Unified Code for Units of Measur
e](http://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit`
bit * `By` byte * `s` second * `min` minute * `h` hour * `d` day **Prefixes (PR
EFIX)** * `k` kilo (10**3) * `M` mega (10**6) * `G` giga (10**9) * `T` tera (10*
*12) * `P` peta (10**15) * `E` exa (10**18) * `Z` zetta (10**21) * `Y` yotta (10
**24) * `m` milli (10**-3) * `u` micro (10**-6) * `n` nano (10**-9) * `p` pico (
10**-12) * `f` femto (10**-15) * `a` atto (10**-18) * `z` zepto (10**-21) * `y`
yocto (10**-24) * `Ki` kibi (2**10) * `Mi` mebi (2**20) * `Gi` gibi (2**30) * `T
i` tebi (2**40) **Grammar** The grammar includes the dimensionless unit `1`, suc
h as `1/s`. The grammar also includes these connectors: * `/` division (as an in
fix operator, e.g. `1/s`). * `.` multiplication (as an infix operator, e.g. `GBy
.d`) The grammar for a unit is as follows: Expression = Component { \".\" Compon
ent } { \"/\" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] | Annotat
ion | \"1\" ; Annotation = \"{\" NAME \"}\" ; Notes: * `Annotation` is just a co
mment if it follows a `UNIT` and is equivalent to `1` if it is used alone. For e
xamples, `{requests}/s == 1/s`, `By{transmitted}/s == By/s`. * `NAME` is a seque
nce of non-blank printable ASCII characters not containing '{' or '}'.", | 1409 "Field type unknown.", |
1221 "type": "string" | 1410 "Field type double.", |
1222 }, | 1411 "Field type float.", |
1223 "description": { | 1412 "Field type int64.", |
1224 "description": "A detailed description of the metric, which
can be used in documentation.", | 1413 "Field type uint64.", |
1225 "type": "string" | 1414 "Field type int32.", |
1226 }, | 1415 "Field type fixed64.", |
1227 "displayName": { | 1416 "Field type fixed32.", |
1228 "description": "A concise name for the metric, which can be
displayed in user interfaces. Use sentence case without an ending period, for ex
ample \"Request count\".", | 1417 "Field type bool.", |
1229 "type": "string" | 1418 "Field type string.", |
1230 } | 1419 "Field type group. Proto2 syntax only, and deprecated.", |
1231 }, | 1420 "Field type message.", |
1232 "type": "object" | 1421 "Field type bytes.", |
1233 }, | 1422 "Field type uint32.", |
1234 "ListTimeSeriesResponse": { | 1423 "Field type enum.", |
1235 "description": "The `ListTimeSeries` response.", | 1424 "Field type sfixed32.", |
1236 "id": "ListTimeSeriesResponse", | 1425 "Field type sfixed64.", |
| 1426 "Field type sint32.", |
| 1427 "Field type sint64." |
| 1428 ], |
| 1429 "type": "string" |
| 1430 } |
| 1431 }, |
| 1432 "type": "object" |
| 1433 }, |
| 1434 "Option": { |
| 1435 "description": "A protocol buffer option, which can be attached to a
message, field, enumeration, etc.", |
| 1436 "id": "Option", |
| 1437 "properties": { |
| 1438 "value": { |
| 1439 "additionalProperties": { |
| 1440 "description": "Properties of the object. Contains field
@type with type URL.", |
| 1441 "type": "any" |
| 1442 }, |
| 1443 "description": "The option's value. For example, "com.g
oogle.protobuf".", |
| 1444 "type": "object" |
| 1445 }, |
| 1446 "name": { |
| 1447 "description": "The option's name. For example, "java_p
ackage".", |
| 1448 "type": "string" |
| 1449 } |
| 1450 }, |
| 1451 "type": "object" |
| 1452 }, |
| 1453 "Empty": { |
| 1454 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance:\nservice Fo
o {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe J
SON representation for Empty is empty JSON object {}.", |
| 1455 "id": "Empty", |
| 1456 "properties": {}, |
| 1457 "type": "object" |
| 1458 }, |
| 1459 "SourceContext": { |
| 1460 "description": "SourceContext represents information about the sourc
e of a protobuf element, like the file in which it is defined.", |
| 1461 "id": "SourceContext", |
| 1462 "properties": { |
| 1463 "fileName": { |
| 1464 "description": "The path-qualified name of the .proto file t
hat contained the associated protobuf element. For example: "google/protobu
f/source_context.proto".", |
| 1465 "type": "string" |
| 1466 } |
| 1467 }, |
| 1468 "type": "object" |
| 1469 }, |
| 1470 "Range": { |
| 1471 "description": "The range of the population values.", |
| 1472 "id": "Range", |
| 1473 "properties": { |
| 1474 "max": { |
| 1475 "description": "The maximum of the population values.", |
| 1476 "format": "double", |
| 1477 "type": "number" |
| 1478 }, |
| 1479 "min": { |
| 1480 "description": "The minimum of the population values.", |
| 1481 "format": "double", |
| 1482 "type": "number" |
| 1483 } |
| 1484 }, |
| 1485 "type": "object" |
| 1486 }, |
| 1487 "CreateTimeSeriesRequest": { |
| 1488 "description": "The CreateTimeSeries request.", |
| 1489 "id": "CreateTimeSeriesRequest", |
1237 "properties": { | 1490 "properties": { |
1238 "timeSeries": { | 1491 "timeSeries": { |
1239 "description": "One or more time series that match the filte
r included in the request.", | 1492 "description": "The new data to be added to a list of time s
eries. Adds at most one data point to each of several time series. The new data
point must be more recent than any other point in its time series. Each TimeSeri
es value must fully specify a unique time series by supplying all label values f
or the metric and the monitored resource.", |
1240 "items": { | 1493 "items": { |
1241 "$ref": "TimeSeries" | 1494 "$ref": "TimeSeries" |
1242 }, | 1495 }, |
1243 "type": "array" | |
1244 }, | |
1245 "nextPageToken": { | |
1246 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as `pageToken` in the next call to this method.", | |
1247 "type": "string" | |
1248 } | |
1249 }, | |
1250 "type": "object" | |
1251 }, | |
1252 "TimeSeries": { | |
1253 "description": "A collection of data points that describes the time-
varying nature of a metric. A time series is identified by a combination of a fu
lly-specified monitored resource and a fully-specified metric.", | |
1254 "id": "TimeSeries", | |
1255 "properties": { | |
1256 "metric": { | |
1257 "$ref": "Metric", | |
1258 "description": "The fully-specified metric used to identify
the time series." | |
1259 }, | |
1260 "resource": { | |
1261 "$ref": "MonitoredResource", | |
1262 "description": "The fully-specified monitored resource used
to identify the time series." | |
1263 }, | |
1264 "metricKind": { | |
1265 "description": "The metric kind of the time series. This can
be different than the metric kind specified in [google.api.MetricDescriptor] be
cause of alignment and reduction operations on the data. This field is ignored w
hen writing data; the value specified in the descriptor is used instead. @Output
Only", | |
1266 "enum": [ | |
1267 "METRIC_KIND_UNSPECIFIED", | |
1268 "GAUGE", | |
1269 "DELTA", | |
1270 "CUMULATIVE" | |
1271 ], | |
1272 "type": "string" | |
1273 }, | |
1274 "valueType": { | |
1275 "description": "The value type of the time series. This can
be different than the value type specified in [google.api.MetricDescriptor] beca
use of alignment and reduction operations on the data. This field is ignored whe
n writing data; the value specified in the descriptor is used instead. @OutputOn
ly", | |
1276 "enum": [ | |
1277 "VALUE_TYPE_UNSPECIFIED", | |
1278 "BOOL", | |
1279 "INT64", | |
1280 "DOUBLE", | |
1281 "STRING", | |
1282 "DISTRIBUTION", | |
1283 "MONEY" | |
1284 ], | |
1285 "type": "string" | |
1286 }, | |
1287 "points": { | |
1288 "description": "The data points of this time series. When us
ed as output, points will be sorted by decreasing time order. When used as input
, points could be written in any orders.", | |
1289 "items": { | |
1290 "$ref": "Point" | |
1291 }, | |
1292 "type": "array" | |
1293 } | |
1294 }, | |
1295 "type": "object" | |
1296 }, | |
1297 "Metric": { | |
1298 "description": "A specific metric identified by specifying values fo
r all of the labels of a `MetricDescriptor`.", | |
1299 "id": "Metric", | |
1300 "properties": { | |
1301 "type": { | |
1302 "description": "An existing metric type, see google.api.Metr
icDescriptor. For example, `compute.googleapis.com/instance/cpu/usage_time`.", | |
1303 "type": "string" | |
1304 }, | |
1305 "labels": { | |
1306 "additionalProperties": { | |
1307 "type": "string" | |
1308 }, | |
1309 "description": "The set of labels that uniquely identify a m
etric. To specify a metric, all labels enumerated in the `MetricDescriptor` must
be assigned values.", | |
1310 "type": "object" | |
1311 } | |
1312 }, | |
1313 "type": "object" | |
1314 }, | |
1315 "Point": { | |
1316 "description": "A single data point in a time series.", | |
1317 "id": "Point", | |
1318 "properties": { | |
1319 "interval": { | |
1320 "$ref": "TimeInterval", | |
1321 "description": "The time interval to which the value applies
." | |
1322 }, | |
1323 "value": { | |
1324 "$ref": "TypedValue", | |
1325 "description": "The value of the data point." | |
1326 } | |
1327 }, | |
1328 "type": "object" | |
1329 }, | |
1330 "TimeInterval": { | |
1331 "description": "A time interval extending from after `startTime` thr
ough `endTime`. If `startTime` is omitted, the interval is the single point in t
ime, `endTime`.", | |
1332 "id": "TimeInterval", | |
1333 "properties": { | |
1334 "endTime": { | |
1335 "description": "Required. The end of the interval. The inter
val includes this time.", | |
1336 "type": "string" | |
1337 }, | |
1338 "startTime": { | |
1339 "description": "If this value is omitted, the interval is a
point in time, `endTime`. If `startTime` is present, it must be earlier than (le
ss than) `endTime`. The interval begins after `startTime`—it does not include `s
tartTime`.", | |
1340 "type": "string" | |
1341 } | |
1342 }, | |
1343 "type": "object" | |
1344 }, | |
1345 "CreateTimeSeriesRequest": { | |
1346 "description": "The `CreateTimeSeries` request.", | |
1347 "id": "CreateTimeSeriesRequest", | |
1348 "properties": { | |
1349 "timeSeries": { | |
1350 "description": "The new data to be added to a list of time s
eries. Adds at most one data point to each of several time series. The new data
point must be more recent than any other point in its time series. Each `TimeSer
ies` value must fully specify a unique time series by supplying all label values
for the metric and the monitored resource.", | |
1351 "items": { | |
1352 "$ref": "TimeSeries" | |
1353 }, | |
1354 "type": "array" | 1496 "type": "array" |
1355 } | 1497 } |
1356 }, | 1498 }, |
1357 "type": "object" | 1499 "type": "object" |
1358 }, | 1500 }, |
| 1501 "BucketOptions": { |
| 1502 "description": "A Distribution may optionally contain a histogram of
the values in the population. The histogram is given in bucket_counts as counts
of values that fall into one of a sequence of non-overlapping buckets. The sequ
ence of buckets is described by bucket_options.A bucket specifies an inclusive l
ower bound and exclusive upper bound for the values that are counted for that bu
cket. The upper bound of a bucket is strictly greater than the lower bound.The s
equence of N buckets for a Distribution consists of an underflow bucket (number
0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket
(number N - 1). The buckets are contiguous: the lower bound of bucket i (i >
0) is the same as the upper bound of bucket i - 1. The buckets span the whole ra
nge of finite values: lower bound of the underflow bucket is -infinity and the u
pper bound of the overflow bucket is +infinity. The finite buckets are so-called
because both bounds are finite.BucketOptions describes bucket boundaries in one
of three ways. Two describe the boundaries by giving parameters for a formula t
o generate boundaries and one gives the bucket boundaries explicitly.If bucket_o
ptions is not given, then no bucket_counts may be given.", |
| 1503 "id": "BucketOptions", |
| 1504 "properties": { |
| 1505 "explicitBuckets": { |
| 1506 "$ref": "Explicit", |
| 1507 "description": "The explicit buckets." |
| 1508 }, |
| 1509 "exponentialBuckets": { |
| 1510 "$ref": "Exponential", |
| 1511 "description": "The exponential buckets." |
| 1512 }, |
| 1513 "linearBuckets": { |
| 1514 "$ref": "Linear", |
| 1515 "description": "The linear bucket." |
| 1516 } |
| 1517 }, |
| 1518 "type": "object" |
| 1519 }, |
| 1520 "CreateCollectdTimeSeriesRequest": { |
| 1521 "description": "The CreateCollectdTimeSeries request.", |
| 1522 "id": "CreateCollectdTimeSeriesRequest", |
| 1523 "properties": { |
| 1524 "collectdPayloads": { |
| 1525 "description": "The collectd payloads representing the time
series data. You must not include more than a single point for each time series,
so no two payloads can have the same values for all of the fields plugin, plugi
n_instance, type, and type_instance.", |
| 1526 "items": { |
| 1527 "$ref": "CollectdPayload" |
| 1528 }, |
| 1529 "type": "array" |
| 1530 }, |
| 1531 "collectdVersion": { |
| 1532 "description": "The version of collectd that collected the d
ata. Example: "5.3.0-192.el6".", |
| 1533 "type": "string" |
| 1534 }, |
| 1535 "resource": { |
| 1536 "$ref": "MonitoredResource", |
| 1537 "description": "The monitored resource associated with the t
ime series." |
| 1538 } |
| 1539 }, |
| 1540 "type": "object" |
| 1541 }, |
1359 "Type": { | 1542 "Type": { |
1360 "description": "A protocol buffer message type.", | 1543 "description": "A protocol buffer message type.", |
1361 "id": "Type", | 1544 "id": "Type", |
1362 "properties": { | 1545 "properties": { |
1363 "name": { | |
1364 "description": "The fully qualified message name.", | |
1365 "type": "string" | |
1366 }, | |
1367 "fields": { | |
1368 "description": "The list of fields.", | |
1369 "items": { | |
1370 "$ref": "Field" | |
1371 }, | |
1372 "type": "array" | |
1373 }, | |
1374 "oneofs": { | 1546 "oneofs": { |
1375 "description": "The list of types appearing in `oneof` defin
itions in this type.", | 1547 "description": "The list of types appearing in oneof definit
ions in this type.", |
1376 "items": { | 1548 "items": { |
1377 "type": "string" | 1549 "type": "string" |
1378 }, | 1550 }, |
1379 "type": "array" | 1551 "type": "array" |
1380 }, | 1552 }, |
1381 "options": { | 1553 "options": { |
1382 "description": "The protocol buffer options.", | 1554 "description": "The protocol buffer options.", |
1383 "items": { | 1555 "items": { |
1384 "$ref": "Option" | 1556 "$ref": "Option" |
1385 }, | 1557 }, |
1386 "type": "array" | 1558 "type": "array" |
1387 }, | 1559 }, |
1388 "sourceContext": { | 1560 "sourceContext": { |
1389 "$ref": "SourceContext", | 1561 "$ref": "SourceContext", |
1390 "description": "The source context." | 1562 "description": "The source context." |
1391 }, | 1563 }, |
| 1564 "fields": { |
| 1565 "description": "The list of fields.", |
| 1566 "items": { |
| 1567 "$ref": "Field" |
| 1568 }, |
| 1569 "type": "array" |
| 1570 }, |
| 1571 "name": { |
| 1572 "description": "The fully qualified message name.", |
| 1573 "type": "string" |
| 1574 }, |
1392 "syntax": { | 1575 "syntax": { |
1393 "description": "The source syntax.", | 1576 "description": "The source syntax.", |
1394 "enum": [ | 1577 "enum": [ |
1395 "SYNTAX_PROTO2", | 1578 "SYNTAX_PROTO2", |
1396 "SYNTAX_PROTO3" | 1579 "SYNTAX_PROTO3" |
1397 ], | 1580 ], |
| 1581 "enumDescriptions": [ |
| 1582 "Syntax proto2.", |
| 1583 "Syntax proto3." |
| 1584 ], |
1398 "type": "string" | 1585 "type": "string" |
1399 } | 1586 } |
1400 }, | 1587 }, |
1401 "type": "object" | 1588 "type": "object" |
1402 }, | 1589 }, |
1403 "Field": { | 1590 "ListGroupsResponse": { |
1404 "description": "A single field of a message type.", | 1591 "description": "The ListGroups response.", |
1405 "id": "Field", | 1592 "id": "ListGroupsResponse", |
1406 "properties": { | 1593 "properties": { |
1407 "kind": { | 1594 "group": { |
1408 "description": "The field type.", | 1595 "description": "The groups that match the specified filters.
", |
1409 "enum": [ | |
1410 "TYPE_UNKNOWN", | |
1411 "TYPE_DOUBLE", | |
1412 "TYPE_FLOAT", | |
1413 "TYPE_INT64", | |
1414 "TYPE_UINT64", | |
1415 "TYPE_INT32", | |
1416 "TYPE_FIXED64", | |
1417 "TYPE_FIXED32", | |
1418 "TYPE_BOOL", | |
1419 "TYPE_STRING", | |
1420 "TYPE_GROUP", | |
1421 "TYPE_MESSAGE", | |
1422 "TYPE_BYTES", | |
1423 "TYPE_UINT32", | |
1424 "TYPE_ENUM", | |
1425 "TYPE_SFIXED32", | |
1426 "TYPE_SFIXED64", | |
1427 "TYPE_SINT32", | |
1428 "TYPE_SINT64" | |
1429 ], | |
1430 "type": "string" | |
1431 }, | |
1432 "cardinality": { | |
1433 "description": "The field cardinality.", | |
1434 "enum": [ | |
1435 "CARDINALITY_UNKNOWN", | |
1436 "CARDINALITY_OPTIONAL", | |
1437 "CARDINALITY_REQUIRED", | |
1438 "CARDINALITY_REPEATED" | |
1439 ], | |
1440 "type": "string" | |
1441 }, | |
1442 "number": { | |
1443 "description": "The field number.", | |
1444 "format": "int32", | |
1445 "type": "integer" | |
1446 }, | |
1447 "name": { | |
1448 "description": "The field name.", | |
1449 "type": "string" | |
1450 }, | |
1451 "typeUrl": { | |
1452 "description": "The field type URL, without the scheme, for
message or enumeration types. Example: `\"type.googleapis.com/google.protobuf.Ti
mestamp\"`.", | |
1453 "type": "string" | |
1454 }, | |
1455 "oneofIndex": { | |
1456 "description": "The index of the field type in `Type.oneofs`
, for message or enumeration types. The first type has index 1; zero means the t
ype is not in the list.", | |
1457 "format": "int32", | |
1458 "type": "integer" | |
1459 }, | |
1460 "packed": { | |
1461 "description": "Whether to use alternative packed wire repre
sentation.", | |
1462 "type": "boolean" | |
1463 }, | |
1464 "options": { | |
1465 "description": "The protocol buffer options.", | |
1466 "items": { | 1596 "items": { |
1467 "$ref": "Option" | 1597 "$ref": "Group" |
1468 }, | 1598 }, |
1469 "type": "array" | 1599 "type": "array" |
1470 }, | 1600 }, |
1471 "jsonName": { | 1601 "nextPageToken": { |
1472 "description": "The field JSON name.", | 1602 "description": "If there are more results than have been ret
urned, then this field is set to a non-empty value. To see the additional result
s, use that value as pageToken in the next call to this method.", |
1473 "type": "string" | |
1474 }, | |
1475 "defaultValue": { | |
1476 "description": "The string value of the default value of thi
s field. Proto2 syntax only.", | |
1477 "type": "string" | 1603 "type": "string" |
1478 } | 1604 } |
1479 }, | 1605 }, |
1480 "type": "object" | |
1481 }, | |
1482 "Option": { | |
1483 "description": "A protocol buffer option, which can be attached to a
message, field, enumeration, etc.", | |
1484 "id": "Option", | |
1485 "properties": { | |
1486 "name": { | |
1487 "description": "The option's name. For example, `\"java_pack
age\"`.", | |
1488 "type": "string" | |
1489 }, | |
1490 "value": { | |
1491 "additionalProperties": { | |
1492 "description": "Properties of the object. Contains field
@ype with type URL.", | |
1493 "type": "any" | |
1494 }, | |
1495 "description": "The option's value. For example, `\"com.goog
le.protobuf\"`.", | |
1496 "type": "object" | |
1497 } | |
1498 }, | |
1499 "type": "object" | |
1500 }, | |
1501 "SourceContext": { | |
1502 "description": "`SourceContext` represents information about the sou
rce of a protobuf element, like the file in which it is defined.", | |
1503 "id": "SourceContext", | |
1504 "properties": { | |
1505 "fileName": { | |
1506 "description": "The path-qualified name of the .proto file t
hat contained the associated protobuf element. For example: `\"google/protobuf/s
ource.proto\"`.", | |
1507 "type": "string" | |
1508 } | |
1509 }, | |
1510 "type": "object" | 1606 "type": "object" |
1511 } | 1607 } |
1512 }, | 1608 }, |
1513 "servicePath": "", | 1609 "servicePath": "", |
1514 "title": "Google Monitoring API", | 1610 "title": "Stackdriver Monitoring API", |
1515 "version": "v3" | 1611 "version": "v3" |
1516 } | 1612 } |
OLD | NEW |