OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
| 5 "https://www.googleapis.com/auth/monitoring": { |
| 6 "description": "View and write monitoring data for all of yo
ur Google and third-party Cloud and API projects" |
| 7 }, |
5 "https://www.googleapis.com/auth/monitoring.write": { | 8 "https://www.googleapis.com/auth/monitoring.write": { |
6 "description": "Publish metric data to your Google Cloud pro
jects" | 9 "description": "Publish metric data to your Google Cloud pro
jects" |
7 }, | 10 }, |
8 "https://www.googleapis.com/auth/cloud-platform": { | |
9 "description": "View and manage your data across Google Clou
d Platform services" | |
10 }, | |
11 "https://www.googleapis.com/auth/monitoring.read": { | 11 "https://www.googleapis.com/auth/monitoring.read": { |
12 "description": "View monitoring data for all of your Google
Cloud and third-party projects" | 12 "description": "View monitoring data for all of your Google
Cloud and third-party projects" |
13 }, | 13 }, |
14 "https://www.googleapis.com/auth/monitoring": { | 14 "https://www.googleapis.com/auth/cloud-platform": { |
15 "description": "View and write monitoring data for all of yo
ur Google and third-party Cloud and API projects" | 15 "description": "View and manage your data across Google Clou
d Platform services" |
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 "canonicalName": "Monitoring", | 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 "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.", |
25 "discoveryVersion": "v1", | 25 "discoveryVersion": "v1", |
26 "documentationLink": "https://cloud.google.com/monitoring/api/", | 26 "documentationLink": "https://cloud.google.com/monitoring/api/", |
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 "upload_protocol": { | 37 "fields": { |
38 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 38 "description": "Selector specifying which fields to include in a par
tial response.", |
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 "uploadType": { | 42 "uploadType": { |
49 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 43 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
50 "location": "query", | 44 "location": "query", |
51 "type": "string" | 45 "type": "string" |
52 }, | 46 }, |
53 "fields": { | |
54 "description": "Selector specifying which fields to include in a par
tial response.", | |
55 "location": "query", | |
56 "type": "string" | |
57 }, | |
58 "$.xgafv": { | 47 "$.xgafv": { |
59 "description": "V1 error format.", | 48 "description": "V1 error format.", |
60 "enum": [ | 49 "enum": [ |
61 "1", | 50 "1", |
62 "2" | 51 "2" |
63 ], | 52 ], |
64 "enumDescriptions": [ | 53 "enumDescriptions": [ |
65 "v1 error format", | 54 "v1 error format", |
66 "v2 error format" | 55 "v2 error format" |
67 ], | 56 ], |
(...skipping 14 matching lines...) Expand all Loading... |
82 "proto" | 71 "proto" |
83 ], | 72 ], |
84 "enumDescriptions": [ | 73 "enumDescriptions": [ |
85 "Responses with Content-Type of application/json", | 74 "Responses with Content-Type of application/json", |
86 "Media download with context-dependent Content-Type", | 75 "Media download with context-dependent Content-Type", |
87 "Responses with Content-Type of application/x-protobuf" | 76 "Responses with Content-Type of application/x-protobuf" |
88 ], | 77 ], |
89 "location": "query", | 78 "location": "query", |
90 "type": "string" | 79 "type": "string" |
91 }, | 80 }, |
| 81 "key": { |
| 82 "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.", |
| 83 "location": "query", |
| 84 "type": "string" |
| 85 }, |
92 "access_token": { | 86 "access_token": { |
93 "description": "OAuth access token.", | 87 "description": "OAuth access token.", |
94 "location": "query", | 88 "location": "query", |
95 "type": "string" | 89 "type": "string" |
96 }, | 90 }, |
97 "key": { | |
98 "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.", | |
99 "location": "query", | |
100 "type": "string" | |
101 }, | |
102 "quotaUser": { | 91 "quotaUser": { |
103 "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 "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.", |
104 "location": "query", | 93 "location": "query", |
105 "type": "string" | 94 "type": "string" |
106 }, | 95 }, |
107 "pp": { | 96 "pp": { |
108 "default": "true", | 97 "default": "true", |
109 "description": "Pretty-print response.", | 98 "description": "Pretty-print response.", |
110 "location": "query", | 99 "location": "query", |
111 "type": "boolean" | 100 "type": "boolean" |
112 }, | 101 }, |
113 "oauth_token": { | 102 "oauth_token": { |
114 "description": "OAuth 2.0 token for the current user.", | 103 "description": "OAuth 2.0 token for the current user.", |
115 "location": "query", | 104 "location": "query", |
116 "type": "string" | 105 "type": "string" |
117 }, | 106 }, |
118 "bearer_token": { | 107 "bearer_token": { |
119 "description": "OAuth bearer token.", | 108 "description": "OAuth bearer token.", |
120 "location": "query", | 109 "location": "query", |
121 "type": "string" | 110 "type": "string" |
| 111 }, |
| 112 "upload_protocol": { |
| 113 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 114 "location": "query", |
| 115 "type": "string" |
| 116 }, |
| 117 "prettyPrint": { |
| 118 "default": "true", |
| 119 "description": "Returns response with indentations and line breaks."
, |
| 120 "location": "query", |
| 121 "type": "boolean" |
122 } | 122 } |
123 }, | 123 }, |
124 "protocol": "rest", | 124 "protocol": "rest", |
125 "resources": { | 125 "resources": { |
126 "projects": { | 126 "projects": { |
127 "resources": { | 127 "resources": { |
| 128 "groups": { |
| 129 "methods": { |
| 130 "update": { |
| 131 "description": "Updates an existing group. You can c
hange any group attributes except name.", |
| 132 "httpMethod": "PUT", |
| 133 "id": "monitoring.projects.groups.update", |
| 134 "parameterOrder": [ |
| 135 "name" |
| 136 ], |
| 137 "parameters": { |
| 138 "validateOnly": { |
| 139 "description": "If true, validate this reque
st but do not update the existing group.", |
| 140 "location": "query", |
| 141 "type": "boolean" |
| 142 }, |
| 143 "name": { |
| 144 "description": "Output only. The name of thi
s group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". Wh
en creating a group, this field 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 automatically.", |
| 145 "location": "path", |
| 146 "pattern": "^projects/[^/]+/groups/[^/]+$", |
| 147 "required": true, |
| 148 "type": "string" |
| 149 } |
| 150 }, |
| 151 "path": "v3/{+name}", |
| 152 "request": { |
| 153 "$ref": "Group" |
| 154 }, |
| 155 "response": { |
| 156 "$ref": "Group" |
| 157 }, |
| 158 "scopes": [ |
| 159 "https://www.googleapis.com/auth/cloud-platform"
, |
| 160 "https://www.googleapis.com/auth/monitoring" |
| 161 ] |
| 162 }, |
| 163 "create": { |
| 164 "description": "Creates a new group.", |
| 165 "httpMethod": "POST", |
| 166 "id": "monitoring.projects.groups.create", |
| 167 "parameterOrder": [ |
| 168 "name" |
| 169 ], |
| 170 "parameters": { |
| 171 "validateOnly": { |
| 172 "description": "If true, validate this reque
st but do not create the group.", |
| 173 "location": "query", |
| 174 "type": "boolean" |
| 175 }, |
| 176 "name": { |
| 177 "description": "The project in which to crea
te the group. The format is \"projects/{project_id_or_number}\".", |
| 178 "location": "path", |
| 179 "pattern": "^projects/[^/]+$", |
| 180 "required": true, |
| 181 "type": "string" |
| 182 } |
| 183 }, |
| 184 "path": "v3/{+name}/groups", |
| 185 "request": { |
| 186 "$ref": "Group" |
| 187 }, |
| 188 "response": { |
| 189 "$ref": "Group" |
| 190 }, |
| 191 "scopes": [ |
| 192 "https://www.googleapis.com/auth/cloud-platform"
, |
| 193 "https://www.googleapis.com/auth/monitoring" |
| 194 ] |
| 195 }, |
| 196 "delete": { |
| 197 "description": "Deletes an existing group.", |
| 198 "httpMethod": "DELETE", |
| 199 "id": "monitoring.projects.groups.delete", |
| 200 "parameterOrder": [ |
| 201 "name" |
| 202 ], |
| 203 "parameters": { |
| 204 "name": { |
| 205 "description": "The group to delete. The for
mat is \"projects/{project_id_or_number}/groups/{group_id}\".", |
| 206 "location": "path", |
| 207 "pattern": "^projects/[^/]+/groups/[^/]+$", |
| 208 "required": true, |
| 209 "type": "string" |
| 210 } |
| 211 }, |
| 212 "path": "v3/{+name}", |
| 213 "response": { |
| 214 "$ref": "Empty" |
| 215 }, |
| 216 "scopes": [ |
| 217 "https://www.googleapis.com/auth/cloud-platform"
, |
| 218 "https://www.googleapis.com/auth/monitoring" |
| 219 ] |
| 220 }, |
| 221 "get": { |
| 222 "description": "Gets a single group.", |
| 223 "httpMethod": "GET", |
| 224 "id": "monitoring.projects.groups.get", |
| 225 "parameterOrder": [ |
| 226 "name" |
| 227 ], |
| 228 "parameters": { |
| 229 "name": { |
| 230 "description": "The group to retrieve. The f
ormat is \"projects/{project_id_or_number}/groups/{group_id}\".", |
| 231 "location": "path", |
| 232 "pattern": "^projects/[^/]+/groups/[^/]+$", |
| 233 "required": true, |
| 234 "type": "string" |
| 235 } |
| 236 }, |
| 237 "path": "v3/{+name}", |
| 238 "response": { |
| 239 "$ref": "Group" |
| 240 }, |
| 241 "scopes": [ |
| 242 "https://www.googleapis.com/auth/cloud-platform"
, |
| 243 "https://www.googleapis.com/auth/monitoring", |
| 244 "https://www.googleapis.com/auth/monitoring.read
" |
| 245 ] |
| 246 }, |
| 247 "list": { |
| 248 "description": "Lists the existing groups.", |
| 249 "httpMethod": "GET", |
| 250 "id": "monitoring.projects.groups.list", |
| 251 "parameterOrder": [ |
| 252 "name" |
| 253 ], |
| 254 "parameters": { |
| 255 "name": { |
| 256 "description": "The project whose groups are
to be listed. The format is \"projects/{project_id_or_number}\".", |
| 257 "location": "path", |
| 258 "pattern": "^projects/[^/]+$", |
| 259 "required": true, |
| 260 "type": "string" |
| 261 }, |
| 262 "childrenOfGroup": { |
| 263 "description": "A group name: \"projects/{pr
oject_id_or_number}/groups/{group_id}\". Returns groups whose parentName field c
ontains the group name. If no groups have this parent, the results are empty.", |
| 264 "location": "query", |
| 265 "type": "string" |
| 266 }, |
| 267 "descendantsOfGroup": { |
| 268 "description": "A group name: \"projects/{pr
oject_id_or_number}/groups/{group_id}\". Returns the descendants of the specifie
d group. This is a superset of the results returned by the childrenOfGroup filte
r, and includes children-of-children, and so forth.", |
| 269 "location": "query", |
| 270 "type": "string" |
| 271 }, |
| 272 "pageToken": { |
| 273 "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.", |
| 274 "location": "query", |
| 275 "type": "string" |
| 276 }, |
| 277 "pageSize": { |
| 278 "description": "A positive number that is th
e maximum number of results to return.", |
| 279 "format": "int32", |
| 280 "location": "query", |
| 281 "type": "integer" |
| 282 }, |
| 283 "ancestorsOfGroup": { |
| 284 "description": "A group name: \"projects/{pr
oject_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of th
e specified group. The groups are returned in order, starting with the immediate
parent and ending with the most distant ancestor. If the specified group has no
immediate parent, the results are empty.", |
| 285 "location": "query", |
| 286 "type": "string" |
| 287 } |
| 288 }, |
| 289 "path": "v3/{+name}/groups", |
| 290 "response": { |
| 291 "$ref": "ListGroupsResponse" |
| 292 }, |
| 293 "scopes": [ |
| 294 "https://www.googleapis.com/auth/cloud-platform"
, |
| 295 "https://www.googleapis.com/auth/monitoring", |
| 296 "https://www.googleapis.com/auth/monitoring.read
" |
| 297 ] |
| 298 } |
| 299 }, |
| 300 "resources": { |
| 301 "members": { |
| 302 "methods": { |
| 303 "list": { |
| 304 "description": "Lists the monitored resource
s that are members of a group.", |
| 305 "httpMethod": "GET", |
| 306 "id": "monitoring.projects.groups.members.li
st", |
| 307 "parameterOrder": [ |
| 308 "name" |
| 309 ], |
| 310 "parameters": { |
| 311 "interval.endTime": { |
| 312 "description": "Required. The end of
the time interval.", |
| 313 "format": "google-datetime", |
| 314 "location": "query", |
| 315 "type": "string" |
| 316 }, |
| 317 "filter": { |
| 318 "description": "An optional list fil
ter describing the members to be returned. The filter may reference the type, la
bels, and metadata of monitored resources that comprise the group. For example,
to return only resources representing Compute Engine VM instances, use this filt
er:\nresource.type = \"gce_instance\"\n", |
| 319 "location": "query", |
| 320 "type": "string" |
| 321 }, |
| 322 "pageToken": { |
| 323 "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.", |
| 324 "location": "query", |
| 325 "type": "string" |
| 326 }, |
| 327 "pageSize": { |
| 328 "description": "A positive number th
at is the maximum number of results to return.", |
| 329 "format": "int32", |
| 330 "location": "query", |
| 331 "type": "integer" |
| 332 }, |
| 333 "interval.startTime": { |
| 334 "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.", |
| 335 "format": "google-datetime", |
| 336 "location": "query", |
| 337 "type": "string" |
| 338 }, |
| 339 "name": { |
| 340 "description": "The group whose memb
ers are listed. The format is \"projects/{project_id_or_number}/groups/{group_id
}\".", |
| 341 "location": "path", |
| 342 "pattern": "^projects/[^/]+/groups/[
^/]+$", |
| 343 "required": true, |
| 344 "type": "string" |
| 345 } |
| 346 }, |
| 347 "path": "v3/{+name}/members", |
| 348 "response": { |
| 349 "$ref": "ListGroupMembersResponse" |
| 350 }, |
| 351 "scopes": [ |
| 352 "https://www.googleapis.com/auth/cloud-p
latform", |
| 353 "https://www.googleapis.com/auth/monitor
ing", |
| 354 "https://www.googleapis.com/auth/monitor
ing.read" |
| 355 ] |
| 356 } |
| 357 } |
| 358 } |
| 359 } |
| 360 }, |
128 "collectdTimeSeries": { | 361 "collectdTimeSeries": { |
129 "methods": { | 362 "methods": { |
130 "create": { | 363 "create": { |
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>", | 364 "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>", |
132 "httpMethod": "POST", | 365 "httpMethod": "POST", |
133 "id": "monitoring.projects.collectdTimeSeries.create
", | 366 "id": "monitoring.projects.collectdTimeSeries.create
", |
134 "parameterOrder": [ | 367 "parameterOrder": [ |
135 "name" | 368 "name" |
136 ], | 369 ], |
137 "parameters": { | 370 "parameters": { |
138 "name": { | 371 "name": { |
139 "description": "The project in which to crea
te the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".", | 372 "description": "The project in which to crea
te the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".", |
140 "location": "path", | 373 "location": "path", |
141 "pattern": "^projects/[^/]+$", | 374 "pattern": "^projects/[^/]+$", |
142 "required": true, | 375 "required": true, |
143 "type": "string" | 376 "type": "string" |
144 } | 377 } |
145 }, | 378 }, |
146 "path": "v3/{+name}/collectdTimeSeries", | 379 "path": "v3/{+name}/collectdTimeSeries", |
147 "request": { | 380 "request": { |
148 "$ref": "CreateCollectdTimeSeriesRequest" | 381 "$ref": "CreateCollectdTimeSeriesRequest" |
149 }, | 382 }, |
150 "response": { | 383 "response": { |
151 "$ref": "Empty" | 384 "$ref": "Empty" |
152 }, | 385 }, |
153 "scopes": [ | 386 "scopes": [ |
154 "https://www.googleapis.com/auth/cloud-platform"
, | 387 "https://www.googleapis.com/auth/cloud-platform"
, |
155 "https://www.googleapis.com/auth/monitoring", | |
156 "https://www.googleapis.com/auth/monitoring.writ
e" | |
157 ] | |
158 } | |
159 } | |
160 }, | |
161 "timeSeries": { | |
162 "methods": { | |
163 "list": { | |
164 "description": "Lists time series that match a filte
r. This method does not require a Stackdriver account.", | |
165 "httpMethod": "GET", | |
166 "id": "monitoring.projects.timeSeries.list", | |
167 "parameterOrder": [ | |
168 "name" | |
169 ], | |
170 "parameters": { | |
171 "pageSize": { | |
172 "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.", | |
173 "format": "int32", | |
174 "location": "query", | |
175 "type": "integer" | |
176 }, | |
177 "orderBy": { | |
178 "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.", | |
179 "location": "query", | |
180 "type": "string" | |
181 }, | |
182 "aggregation.crossSeriesReducer": { | |
183 "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.", | |
184 "enum": [ | |
185 "REDUCE_NONE", | |
186 "REDUCE_MEAN", | |
187 "REDUCE_MIN", | |
188 "REDUCE_MAX", | |
189 "REDUCE_SUM", | |
190 "REDUCE_STDDEV", | |
191 "REDUCE_COUNT", | |
192 "REDUCE_COUNT_TRUE", | |
193 "REDUCE_FRACTION_TRUE", | |
194 "REDUCE_PERCENTILE_99", | |
195 "REDUCE_PERCENTILE_95", | |
196 "REDUCE_PERCENTILE_50", | |
197 "REDUCE_PERCENTILE_05" | |
198 ], | |
199 "location": "query", | |
200 "type": "string" | |
201 }, | |
202 "filter": { | |
203 "description": "A monitoring filter that spe
cifies which time series should be returned. The filter must specify a single me
tric type, and can additionally specify metric labels and other information. For
example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\
n metric.label.instance_name = \"my-instance-name\"\n", | |
204 "location": "query", | |
205 "type": "string" | |
206 }, | |
207 "pageToken": { | |
208 "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.", | |
209 "location": "query", | |
210 "type": "string" | |
211 }, | |
212 "aggregation.perSeriesAligner": { | |
213 "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.", | |
214 "enum": [ | |
215 "ALIGN_NONE", | |
216 "ALIGN_DELTA", | |
217 "ALIGN_RATE", | |
218 "ALIGN_INTERPOLATE", | |
219 "ALIGN_NEXT_OLDER", | |
220 "ALIGN_MIN", | |
221 "ALIGN_MAX", | |
222 "ALIGN_MEAN", | |
223 "ALIGN_COUNT", | |
224 "ALIGN_SUM", | |
225 "ALIGN_STDDEV", | |
226 "ALIGN_COUNT_TRUE", | |
227 "ALIGN_FRACTION_TRUE", | |
228 "ALIGN_PERCENTILE_99", | |
229 "ALIGN_PERCENTILE_95", | |
230 "ALIGN_PERCENTILE_50", | |
231 "ALIGN_PERCENTILE_05" | |
232 ], | |
233 "location": "query", | |
234 "type": "string" | |
235 }, | |
236 "interval.startTime": { | |
237 "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.", | |
238 "format": "google-datetime", | |
239 "location": "query", | |
240 "type": "string" | |
241 }, | |
242 "view": { | |
243 "description": "Specifies which information
is returned about the time series.", | |
244 "enum": [ | |
245 "FULL", | |
246 "HEADERS" | |
247 ], | |
248 "location": "query", | |
249 "type": "string" | |
250 }, | |
251 "name": { | |
252 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", | |
253 "location": "path", | |
254 "pattern": "^projects/[^/]+$", | |
255 "required": true, | |
256 "type": "string" | |
257 }, | |
258 "aggregation.groupByFields": { | |
259 "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. It is not possible t
o reduce across different resource types, so this field implicitly contains reso
urce.type. Fields not specified in groupByFields are aggregated away. If groupBy
Fields is not specified and all the time series have the same resource type, the
n the time series are aggregated into a single output time series. If crossSerie
sReducer is not defined, this field is ignored.", | |
260 "location": "query", | |
261 "repeated": true, | |
262 "type": "string" | |
263 }, | |
264 "interval.endTime": { | |
265 "description": "Required. The end of the tim
e interval.", | |
266 "format": "google-datetime", | |
267 "location": "query", | |
268 "type": "string" | |
269 }, | |
270 "aggregation.alignmentPeriod": { | |
271 "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.", | |
272 "format": "google-duration", | |
273 "location": "query", | |
274 "type": "string" | |
275 } | |
276 }, | |
277 "path": "v3/{+name}/timeSeries", | |
278 "response": { | |
279 "$ref": "ListTimeSeriesResponse" | |
280 }, | |
281 "scopes": [ | |
282 "https://www.googleapis.com/auth/cloud-platform"
, | |
283 "https://www.googleapis.com/auth/monitoring", | |
284 "https://www.googleapis.com/auth/monitoring.read
" | |
285 ] | |
286 }, | |
287 "create": { | |
288 "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.", | |
289 "httpMethod": "POST", | |
290 "id": "monitoring.projects.timeSeries.create", | |
291 "parameterOrder": [ | |
292 "name" | |
293 ], | |
294 "parameters": { | |
295 "name": { | |
296 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", | |
297 "location": "path", | |
298 "pattern": "^projects/[^/]+$", | |
299 "required": true, | |
300 "type": "string" | |
301 } | |
302 }, | |
303 "path": "v3/{+name}/timeSeries", | |
304 "request": { | |
305 "$ref": "CreateTimeSeriesRequest" | |
306 }, | |
307 "response": { | |
308 "$ref": "Empty" | |
309 }, | |
310 "scopes": [ | |
311 "https://www.googleapis.com/auth/cloud-platform"
, | |
312 "https://www.googleapis.com/auth/monitoring", | |
313 "https://www.googleapis.com/auth/monitoring.writ
e" | |
314 ] | |
315 } | |
316 } | |
317 }, | |
318 "metricDescriptors": { | |
319 "methods": { | |
320 "delete": { | |
321 "description": "Deletes a metric descriptor. Only us
er-created custom metrics can be deleted.", | |
322 "httpMethod": "DELETE", | |
323 "id": "monitoring.projects.metricDescriptors.delete"
, | |
324 "parameterOrder": [ | |
325 "name" | |
326 ], | |
327 "parameters": { | |
328 "name": { | |
329 "description": "The metric descriptor on whi
ch to execute the request. The format is \"projects/{project_id_or_number}/metri
cDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.co
m/my_test_metric\".", | |
330 "location": "path", | |
331 "pattern": "^projects/[^/]+/metricDescriptor
s/.+$", | |
332 "required": true, | |
333 "type": "string" | |
334 } | |
335 }, | |
336 "path": "v3/{+name}", | |
337 "response": { | |
338 "$ref": "Empty" | |
339 }, | |
340 "scopes": [ | |
341 "https://www.googleapis.com/auth/cloud-platform"
, | |
342 "https://www.googleapis.com/auth/monitoring" | |
343 ] | |
344 }, | |
345 "list": { | |
346 "description": "Lists metric descriptors that match
a filter. This method does not require a Stackdriver account.", | |
347 "httpMethod": "GET", | |
348 "id": "monitoring.projects.metricDescriptors.list", | |
349 "parameterOrder": [ | |
350 "name" | |
351 ], | |
352 "parameters": { | |
353 "filter": { | |
354 "description": "If this field is empty, all
custom and system-defined metric descriptors are returned. Otherwise, the filter
specifies which metric descriptors are to be returned. For example, the followi
ng filter matches all custom metrics:\nmetric.type = starts_with(\"custom.google
apis.com/\")\n", | |
355 "location": "query", | |
356 "type": "string" | |
357 }, | |
358 "name": { | |
359 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", | |
360 "location": "path", | |
361 "pattern": "^projects/[^/]+$", | |
362 "required": true, | |
363 "type": "string" | |
364 }, | |
365 "pageToken": { | |
366 "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.", | |
367 "location": "query", | |
368 "type": "string" | |
369 }, | |
370 "pageSize": { | |
371 "description": "A positive number that is th
e maximum number of results to return.", | |
372 "format": "int32", | |
373 "location": "query", | |
374 "type": "integer" | |
375 } | |
376 }, | |
377 "path": "v3/{+name}/metricDescriptors", | |
378 "response": { | |
379 "$ref": "ListMetricDescriptorsResponse" | |
380 }, | |
381 "scopes": [ | |
382 "https://www.googleapis.com/auth/cloud-platform"
, | |
383 "https://www.googleapis.com/auth/monitoring", | |
384 "https://www.googleapis.com/auth/monitoring.read
", | |
385 "https://www.googleapis.com/auth/monitoring.writ
e" | |
386 ] | |
387 }, | |
388 "get": { | |
389 "description": "Gets a single metric descriptor. Thi
s method does not require a Stackdriver account.", | |
390 "httpMethod": "GET", | |
391 "id": "monitoring.projects.metricDescriptors.get", | |
392 "parameterOrder": [ | |
393 "name" | |
394 ], | |
395 "parameters": { | |
396 "name": { | |
397 "description": "The metric descriptor on whi
ch to execute the request. The format is \"projects/{project_id_or_number}/metri
cDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googlea
pis.com/instance/disk/read_bytes_count\".", | |
398 "location": "path", | |
399 "pattern": "^projects/[^/]+/metricDescriptor
s/.+$", | |
400 "required": true, | |
401 "type": "string" | |
402 } | |
403 }, | |
404 "path": "v3/{+name}", | |
405 "response": { | |
406 "$ref": "MetricDescriptor" | |
407 }, | |
408 "scopes": [ | |
409 "https://www.googleapis.com/auth/cloud-platform"
, | |
410 "https://www.googleapis.com/auth/monitoring", | |
411 "https://www.googleapis.com/auth/monitoring.read
", | |
412 "https://www.googleapis.com/auth/monitoring.writ
e" | |
413 ] | |
414 }, | |
415 "create": { | |
416 "description": "Creates a new metric descriptor. Use
r-created metric descriptors define custom metrics.", | |
417 "httpMethod": "POST", | |
418 "id": "monitoring.projects.metricDescriptors.create"
, | |
419 "parameterOrder": [ | |
420 "name" | |
421 ], | |
422 "parameters": { | |
423 "name": { | |
424 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", | |
425 "location": "path", | |
426 "pattern": "^projects/[^/]+$", | |
427 "required": true, | |
428 "type": "string" | |
429 } | |
430 }, | |
431 "path": "v3/{+name}/metricDescriptors", | |
432 "request": { | |
433 "$ref": "MetricDescriptor" | |
434 }, | |
435 "response": { | |
436 "$ref": "MetricDescriptor" | |
437 }, | |
438 "scopes": [ | |
439 "https://www.googleapis.com/auth/cloud-platform"
, | |
440 "https://www.googleapis.com/auth/monitoring", | 388 "https://www.googleapis.com/auth/monitoring", |
441 "https://www.googleapis.com/auth/monitoring.writ
e" | 389 "https://www.googleapis.com/auth/monitoring.writ
e" |
442 ] | 390 ] |
443 } | 391 } |
444 } | 392 } |
445 }, | 393 }, |
446 "monitoredResourceDescriptors": { | 394 "timeSeries": { |
447 "methods": { | 395 "methods": { |
448 "list": { | 396 "list": { |
449 "description": "Lists monitored resource descriptors
that match a filter. This method does not require a Stackdriver account.", | 397 "description": "Lists time series that match a filte
r. This method does not require a Stackdriver account.", |
450 "httpMethod": "GET", | 398 "httpMethod": "GET", |
451 "id": "monitoring.projects.monitoredResourceDescript
ors.list", | 399 "id": "monitoring.projects.timeSeries.list", |
452 "parameterOrder": [ | 400 "parameterOrder": [ |
453 "name" | 401 "name" |
454 ], | 402 ], |
455 "parameters": { | 403 "parameters": { |
456 "filter": { | |
457 "description": "An optional filter describin
g the descriptors to be returned. The filter can reference the descriptor's type
and labels. For example, the following filter returns only Google Compute Engin
e descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND
resource.label:id\n", | |
458 "location": "query", | |
459 "type": "string" | |
460 }, | |
461 "name": { | 404 "name": { |
462 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", | 405 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", |
463 "location": "path", | 406 "location": "path", |
464 "pattern": "^projects/[^/]+$", | 407 "pattern": "^projects/[^/]+$", |
465 "required": true, | 408 "required": true, |
466 "type": "string" | 409 "type": "string" |
467 }, | 410 }, |
| 411 "aggregation.groupByFields": { |
| 412 "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. It is not possible t
o reduce across different resource types, so this field implicitly contains reso
urce.type. Fields not specified in groupByFields are aggregated away. If groupBy
Fields is not specified and all the time series have the same resource type, the
n the time series are aggregated into a single output time series. If crossSerie
sReducer is not defined, this field is ignored.", |
| 413 "location": "query", |
| 414 "repeated": true, |
| 415 "type": "string" |
| 416 }, |
| 417 "interval.endTime": { |
| 418 "description": "Required. The end of the tim
e interval.", |
| 419 "format": "google-datetime", |
| 420 "location": "query", |
| 421 "type": "string" |
| 422 }, |
| 423 "aggregation.alignmentPeriod": { |
| 424 "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.", |
| 425 "format": "google-duration", |
| 426 "location": "query", |
| 427 "type": "string" |
| 428 }, |
| 429 "pageSize": { |
| 430 "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.", |
| 431 "format": "int32", |
| 432 "location": "query", |
| 433 "type": "integer" |
| 434 }, |
| 435 "orderBy": { |
| 436 "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.", |
| 437 "location": "query", |
| 438 "type": "string" |
| 439 }, |
| 440 "aggregation.crossSeriesReducer": { |
| 441 "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.", |
| 442 "enum": [ |
| 443 "REDUCE_NONE", |
| 444 "REDUCE_MEAN", |
| 445 "REDUCE_MIN", |
| 446 "REDUCE_MAX", |
| 447 "REDUCE_SUM", |
| 448 "REDUCE_STDDEV", |
| 449 "REDUCE_COUNT", |
| 450 "REDUCE_COUNT_TRUE", |
| 451 "REDUCE_FRACTION_TRUE", |
| 452 "REDUCE_PERCENTILE_99", |
| 453 "REDUCE_PERCENTILE_95", |
| 454 "REDUCE_PERCENTILE_50", |
| 455 "REDUCE_PERCENTILE_05" |
| 456 ], |
| 457 "location": "query", |
| 458 "type": "string" |
| 459 }, |
| 460 "filter": { |
| 461 "description": "A monitoring filter that spe
cifies which time series should be returned. The filter must specify a single me
tric type, and can additionally specify metric labels and other information. For
example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\
n metric.label.instance_name = \"my-instance-name\"\n", |
| 462 "location": "query", |
| 463 "type": "string" |
| 464 }, |
468 "pageToken": { | 465 "pageToken": { |
469 "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.", | 466 "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.", |
470 "location": "query", | 467 "location": "query", |
471 "type": "string" | 468 "type": "string" |
472 }, | 469 }, |
| 470 "aggregation.perSeriesAligner": { |
| 471 "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.", |
| 472 "enum": [ |
| 473 "ALIGN_NONE", |
| 474 "ALIGN_DELTA", |
| 475 "ALIGN_RATE", |
| 476 "ALIGN_INTERPOLATE", |
| 477 "ALIGN_NEXT_OLDER", |
| 478 "ALIGN_MIN", |
| 479 "ALIGN_MAX", |
| 480 "ALIGN_MEAN", |
| 481 "ALIGN_COUNT", |
| 482 "ALIGN_SUM", |
| 483 "ALIGN_STDDEV", |
| 484 "ALIGN_COUNT_TRUE", |
| 485 "ALIGN_FRACTION_TRUE", |
| 486 "ALIGN_PERCENTILE_99", |
| 487 "ALIGN_PERCENTILE_95", |
| 488 "ALIGN_PERCENTILE_50", |
| 489 "ALIGN_PERCENTILE_05" |
| 490 ], |
| 491 "location": "query", |
| 492 "type": "string" |
| 493 }, |
| 494 "interval.startTime": { |
| 495 "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.", |
| 496 "format": "google-datetime", |
| 497 "location": "query", |
| 498 "type": "string" |
| 499 }, |
| 500 "view": { |
| 501 "description": "Specifies which information
is returned about the time series.", |
| 502 "enum": [ |
| 503 "FULL", |
| 504 "HEADERS" |
| 505 ], |
| 506 "location": "query", |
| 507 "type": "string" |
| 508 } |
| 509 }, |
| 510 "path": "v3/{+name}/timeSeries", |
| 511 "response": { |
| 512 "$ref": "ListTimeSeriesResponse" |
| 513 }, |
| 514 "scopes": [ |
| 515 "https://www.googleapis.com/auth/cloud-platform"
, |
| 516 "https://www.googleapis.com/auth/monitoring", |
| 517 "https://www.googleapis.com/auth/monitoring.read
" |
| 518 ] |
| 519 }, |
| 520 "create": { |
| 521 "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.", |
| 522 "httpMethod": "POST", |
| 523 "id": "monitoring.projects.timeSeries.create", |
| 524 "parameterOrder": [ |
| 525 "name" |
| 526 ], |
| 527 "parameters": { |
| 528 "name": { |
| 529 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", |
| 530 "location": "path", |
| 531 "pattern": "^projects/[^/]+$", |
| 532 "required": true, |
| 533 "type": "string" |
| 534 } |
| 535 }, |
| 536 "path": "v3/{+name}/timeSeries", |
| 537 "request": { |
| 538 "$ref": "CreateTimeSeriesRequest" |
| 539 }, |
| 540 "response": { |
| 541 "$ref": "Empty" |
| 542 }, |
| 543 "scopes": [ |
| 544 "https://www.googleapis.com/auth/cloud-platform"
, |
| 545 "https://www.googleapis.com/auth/monitoring", |
| 546 "https://www.googleapis.com/auth/monitoring.writ
e" |
| 547 ] |
| 548 } |
| 549 } |
| 550 }, |
| 551 "metricDescriptors": { |
| 552 "methods": { |
| 553 "delete": { |
| 554 "description": "Deletes a metric descriptor. Only us
er-created custom metrics can be deleted.", |
| 555 "httpMethod": "DELETE", |
| 556 "id": "monitoring.projects.metricDescriptors.delete"
, |
| 557 "parameterOrder": [ |
| 558 "name" |
| 559 ], |
| 560 "parameters": { |
| 561 "name": { |
| 562 "description": "The metric descriptor on whi
ch to execute the request. The format is \"projects/{project_id_or_number}/metri
cDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.co
m/my_test_metric\".", |
| 563 "location": "path", |
| 564 "pattern": "^projects/[^/]+/metricDescriptor
s/.+$", |
| 565 "required": true, |
| 566 "type": "string" |
| 567 } |
| 568 }, |
| 569 "path": "v3/{+name}", |
| 570 "response": { |
| 571 "$ref": "Empty" |
| 572 }, |
| 573 "scopes": [ |
| 574 "https://www.googleapis.com/auth/cloud-platform"
, |
| 575 "https://www.googleapis.com/auth/monitoring" |
| 576 ] |
| 577 }, |
| 578 "get": { |
| 579 "description": "Gets a single metric descriptor. Thi
s method does not require a Stackdriver account.", |
| 580 "httpMethod": "GET", |
| 581 "id": "monitoring.projects.metricDescriptors.get", |
| 582 "parameterOrder": [ |
| 583 "name" |
| 584 ], |
| 585 "parameters": { |
| 586 "name": { |
| 587 "description": "The metric descriptor on whi
ch to execute the request. The format is \"projects/{project_id_or_number}/metri
cDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googlea
pis.com/instance/disk/read_bytes_count\".", |
| 588 "location": "path", |
| 589 "pattern": "^projects/[^/]+/metricDescriptor
s/.+$", |
| 590 "required": true, |
| 591 "type": "string" |
| 592 } |
| 593 }, |
| 594 "path": "v3/{+name}", |
| 595 "response": { |
| 596 "$ref": "MetricDescriptor" |
| 597 }, |
| 598 "scopes": [ |
| 599 "https://www.googleapis.com/auth/cloud-platform"
, |
| 600 "https://www.googleapis.com/auth/monitoring", |
| 601 "https://www.googleapis.com/auth/monitoring.read
", |
| 602 "https://www.googleapis.com/auth/monitoring.writ
e" |
| 603 ] |
| 604 }, |
| 605 "list": { |
| 606 "description": "Lists metric descriptors that match
a filter. This method does not require a Stackdriver account.", |
| 607 "httpMethod": "GET", |
| 608 "id": "monitoring.projects.metricDescriptors.list", |
| 609 "parameterOrder": [ |
| 610 "name" |
| 611 ], |
| 612 "parameters": { |
| 613 "pageToken": { |
| 614 "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.", |
| 615 "location": "query", |
| 616 "type": "string" |
| 617 }, |
| 618 "name": { |
| 619 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", |
| 620 "location": "path", |
| 621 "pattern": "^projects/[^/]+$", |
| 622 "required": true, |
| 623 "type": "string" |
| 624 }, |
473 "pageSize": { | 625 "pageSize": { |
474 "description": "A positive number that is th
e maximum number of results to return.", | 626 "description": "A positive number that is th
e maximum number of results to return.", |
475 "format": "int32", | 627 "format": "int32", |
476 "location": "query", | 628 "location": "query", |
477 "type": "integer" | 629 "type": "integer" |
478 } | 630 }, |
479 }, | 631 "filter": { |
480 "path": "v3/{+name}/monitoredResourceDescriptors", | 632 "description": "If this field is empty, all
custom and system-defined metric descriptors are returned. Otherwise, the filter
specifies which metric descriptors are to be returned. For example, the followi
ng filter matches all custom metrics:\nmetric.type = starts_with(\"custom.google
apis.com/\")\n", |
481 "response": { | 633 "location": "query", |
482 "$ref": "ListMonitoredResourceDescriptorsRespons
e" | 634 "type": "string" |
| 635 } |
| 636 }, |
| 637 "path": "v3/{+name}/metricDescriptors", |
| 638 "response": { |
| 639 "$ref": "ListMetricDescriptorsResponse" |
483 }, | 640 }, |
484 "scopes": [ | 641 "scopes": [ |
485 "https://www.googleapis.com/auth/cloud-platform"
, | 642 "https://www.googleapis.com/auth/cloud-platform"
, |
486 "https://www.googleapis.com/auth/monitoring", | 643 "https://www.googleapis.com/auth/monitoring", |
487 "https://www.googleapis.com/auth/monitoring.read
", | 644 "https://www.googleapis.com/auth/monitoring.read
", |
488 "https://www.googleapis.com/auth/monitoring.writ
e" | 645 "https://www.googleapis.com/auth/monitoring.writ
e" |
489 ] | 646 ] |
490 }, | 647 }, |
| 648 "create": { |
| 649 "description": "Creates a new metric descriptor. Use
r-created metric descriptors define custom metrics.", |
| 650 "httpMethod": "POST", |
| 651 "id": "monitoring.projects.metricDescriptors.create"
, |
| 652 "parameterOrder": [ |
| 653 "name" |
| 654 ], |
| 655 "parameters": { |
| 656 "name": { |
| 657 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", |
| 658 "location": "path", |
| 659 "pattern": "^projects/[^/]+$", |
| 660 "required": true, |
| 661 "type": "string" |
| 662 } |
| 663 }, |
| 664 "path": "v3/{+name}/metricDescriptors", |
| 665 "request": { |
| 666 "$ref": "MetricDescriptor" |
| 667 }, |
| 668 "response": { |
| 669 "$ref": "MetricDescriptor" |
| 670 }, |
| 671 "scopes": [ |
| 672 "https://www.googleapis.com/auth/cloud-platform"
, |
| 673 "https://www.googleapis.com/auth/monitoring", |
| 674 "https://www.googleapis.com/auth/monitoring.writ
e" |
| 675 ] |
| 676 } |
| 677 } |
| 678 }, |
| 679 "monitoredResourceDescriptors": { |
| 680 "methods": { |
491 "get": { | 681 "get": { |
492 "description": "Gets a single monitored resource des
criptor. This method does not require a Stackdriver account.", | 682 "description": "Gets a single monitored resource des
criptor. This method does not require a Stackdriver account.", |
493 "httpMethod": "GET", | 683 "httpMethod": "GET", |
494 "id": "monitoring.projects.monitoredResourceDescript
ors.get", | 684 "id": "monitoring.projects.monitoredResourceDescript
ors.get", |
495 "parameterOrder": [ | 685 "parameterOrder": [ |
496 "name" | 686 "name" |
497 ], | 687 ], |
498 "parameters": { | 688 "parameters": { |
499 "name": { | 689 "name": { |
500 "description": "The monitored resource descr
iptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceD
escriptors/{resource_type}\". The {resource_type} is a predefined type, such as
cloudsql_database.", | 690 "description": "The monitored resource descr
iptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceD
escriptors/{resource_type}\". The {resource_type} is a predefined type, such as
cloudsql_database.", |
501 "location": "path", | 691 "location": "path", |
502 "pattern": "^projects/[^/]+/monitoredResourc
eDescriptors/[^/]+$", | 692 "pattern": "^projects/[^/]+/monitoredResourc
eDescriptors/[^/]+$", |
503 "required": true, | 693 "required": true, |
504 "type": "string" | 694 "type": "string" |
505 } | 695 } |
506 }, | 696 }, |
507 "path": "v3/{+name}", | 697 "path": "v3/{+name}", |
508 "response": { | 698 "response": { |
509 "$ref": "MonitoredResourceDescriptor" | 699 "$ref": "MonitoredResourceDescriptor" |
510 }, | 700 }, |
511 "scopes": [ | 701 "scopes": [ |
512 "https://www.googleapis.com/auth/cloud-platform"
, | 702 "https://www.googleapis.com/auth/cloud-platform"
, |
513 "https://www.googleapis.com/auth/monitoring", | 703 "https://www.googleapis.com/auth/monitoring", |
514 "https://www.googleapis.com/auth/monitoring.read
", | 704 "https://www.googleapis.com/auth/monitoring.read
", |
515 "https://www.googleapis.com/auth/monitoring.writ
e" | 705 "https://www.googleapis.com/auth/monitoring.writ
e" |
516 ] | 706 ] |
517 } | 707 }, |
518 } | |
519 }, | |
520 "groups": { | |
521 "methods": { | |
522 "list": { | 708 "list": { |
523 "description": "Lists the existing groups.", | 709 "description": "Lists monitored resource descriptors
that match a filter. This method does not require a Stackdriver account.", |
524 "httpMethod": "GET", | 710 "httpMethod": "GET", |
525 "id": "monitoring.projects.groups.list", | 711 "id": "monitoring.projects.monitoredResourceDescript
ors.list", |
526 "parameterOrder": [ | 712 "parameterOrder": [ |
527 "name" | 713 "name" |
528 ], | 714 ], |
529 "parameters": { | 715 "parameters": { |
530 "name": { | 716 "filter": { |
531 "description": "The project whose groups are
to be listed. The format is \"projects/{project_id_or_number}\".", | 717 "description": "An optional filter describin
g the descriptors to be returned. The filter can reference the descriptor's type
and labels. For example, the following filter returns only Google Compute Engin
e descriptors that have an id label:\nresource.type = starts_with(\"gce_\") AND
resource.label:id\n", |
532 "location": "path", | |
533 "pattern": "^projects/[^/]+$", | |
534 "required": true, | |
535 "type": "string" | |
536 }, | |
537 "childrenOfGroup": { | |
538 "description": "A group name: \"projects/{pr
oject_id_or_number}/groups/{group_id}\". Returns groups whose parentName field c
ontains the group name. If no groups have this parent, the results are empty.", | |
539 "location": "query", | |
540 "type": "string" | |
541 }, | |
542 "descendantsOfGroup": { | |
543 "description": "A group name: \"projects/{pr
oject_id_or_number}/groups/{group_id}\". Returns the descendants of the specifie
d group. This is a superset of the results returned by the childrenOfGroup filte
r, and includes children-of-children, and so forth.", | |
544 "location": "query", | 718 "location": "query", |
545 "type": "string" | 719 "type": "string" |
546 }, | 720 }, |
547 "pageToken": { | 721 "pageToken": { |
548 "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.", | 722 "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.", |
549 "location": "query", | 723 "location": "query", |
550 "type": "string" | 724 "type": "string" |
551 }, | 725 }, |
| 726 "name": { |
| 727 "description": "The project on which to exec
ute the request. The format is \"projects/{project_id_or_number}\".", |
| 728 "location": "path", |
| 729 "pattern": "^projects/[^/]+$", |
| 730 "required": true, |
| 731 "type": "string" |
| 732 }, |
552 "pageSize": { | 733 "pageSize": { |
553 "description": "A positive number that is th
e maximum number of results to return.", | 734 "description": "A positive number that is th
e maximum number of results to return.", |
554 "format": "int32", | 735 "format": "int32", |
555 "location": "query", | 736 "location": "query", |
556 "type": "integer" | 737 "type": "integer" |
557 }, | 738 } |
558 "ancestorsOfGroup": { | 739 }, |
559 "description": "A group name: \"projects/{pr
oject_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of th
e specified group. The groups are returned in order, starting with the immediate
parent and ending with the most distant ancestor. If the specified group has no
immediate parent, the results are empty.", | 740 "path": "v3/{+name}/monitoredResourceDescriptors", |
560 "location": "query", | 741 "response": { |
561 "type": "string" | 742 "$ref": "ListMonitoredResourceDescriptorsRespons
e" |
562 } | 743 }, |
563 }, | 744 "scopes": [ |
564 "path": "v3/{+name}/groups", | 745 "https://www.googleapis.com/auth/cloud-platform"
, |
565 "response": { | 746 "https://www.googleapis.com/auth/monitoring", |
566 "$ref": "ListGroupsResponse" | 747 "https://www.googleapis.com/auth/monitoring.read
", |
567 }, | 748 "https://www.googleapis.com/auth/monitoring.writ
e" |
568 "scopes": [ | 749 ] |
569 "https://www.googleapis.com/auth/cloud-platform"
, | |
570 "https://www.googleapis.com/auth/monitoring", | |
571 "https://www.googleapis.com/auth/monitoring.read
" | |
572 ] | |
573 }, | |
574 "get": { | |
575 "description": "Gets a single group.", | |
576 "httpMethod": "GET", | |
577 "id": "monitoring.projects.groups.get", | |
578 "parameterOrder": [ | |
579 "name" | |
580 ], | |
581 "parameters": { | |
582 "name": { | |
583 "description": "The group to retrieve. The f
ormat is \"projects/{project_id_or_number}/groups/{group_id}\".", | |
584 "location": "path", | |
585 "pattern": "^projects/[^/]+/groups/[^/]+$", | |
586 "required": true, | |
587 "type": "string" | |
588 } | |
589 }, | |
590 "path": "v3/{+name}", | |
591 "response": { | |
592 "$ref": "Group" | |
593 }, | |
594 "scopes": [ | |
595 "https://www.googleapis.com/auth/cloud-platform"
, | |
596 "https://www.googleapis.com/auth/monitoring", | |
597 "https://www.googleapis.com/auth/monitoring.read
" | |
598 ] | |
599 }, | |
600 "update": { | |
601 "description": "Updates an existing group. You can c
hange any group attributes except name.", | |
602 "httpMethod": "PUT", | |
603 "id": "monitoring.projects.groups.update", | |
604 "parameterOrder": [ | |
605 "name" | |
606 ], | |
607 "parameters": { | |
608 "name": { | |
609 "description": "Output only. The name of thi
s group. The format is \"projects/{project_id_or_number}/groups/{group_id}\". Wh
en creating a group, this field 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 automatically.", | |
610 "location": "path", | |
611 "pattern": "^projects/[^/]+/groups/[^/]+$", | |
612 "required": true, | |
613 "type": "string" | |
614 }, | |
615 "validateOnly": { | |
616 "description": "If true, validate this reque
st but do not update the existing group.", | |
617 "location": "query", | |
618 "type": "boolean" | |
619 } | |
620 }, | |
621 "path": "v3/{+name}", | |
622 "request": { | |
623 "$ref": "Group" | |
624 }, | |
625 "response": { | |
626 "$ref": "Group" | |
627 }, | |
628 "scopes": [ | |
629 "https://www.googleapis.com/auth/cloud-platform"
, | |
630 "https://www.googleapis.com/auth/monitoring" | |
631 ] | |
632 }, | |
633 "create": { | |
634 "description": "Creates a new group.", | |
635 "httpMethod": "POST", | |
636 "id": "monitoring.projects.groups.create", | |
637 "parameterOrder": [ | |
638 "name" | |
639 ], | |
640 "parameters": { | |
641 "name": { | |
642 "description": "The project in which to crea
te the group. The format is \"projects/{project_id_or_number}\".", | |
643 "location": "path", | |
644 "pattern": "^projects/[^/]+$", | |
645 "required": true, | |
646 "type": "string" | |
647 }, | |
648 "validateOnly": { | |
649 "description": "If true, validate this reque
st but do not create the group.", | |
650 "location": "query", | |
651 "type": "boolean" | |
652 } | |
653 }, | |
654 "path": "v3/{+name}/groups", | |
655 "request": { | |
656 "$ref": "Group" | |
657 }, | |
658 "response": { | |
659 "$ref": "Group" | |
660 }, | |
661 "scopes": [ | |
662 "https://www.googleapis.com/auth/cloud-platform"
, | |
663 "https://www.googleapis.com/auth/monitoring" | |
664 ] | |
665 }, | |
666 "delete": { | |
667 "description": "Deletes an existing group.", | |
668 "httpMethod": "DELETE", | |
669 "id": "monitoring.projects.groups.delete", | |
670 "parameterOrder": [ | |
671 "name" | |
672 ], | |
673 "parameters": { | |
674 "name": { | |
675 "description": "The group to delete. The for
mat is \"projects/{project_id_or_number}/groups/{group_id}\".", | |
676 "location": "path", | |
677 "pattern": "^projects/[^/]+/groups/[^/]+$", | |
678 "required": true, | |
679 "type": "string" | |
680 } | |
681 }, | |
682 "path": "v3/{+name}", | |
683 "response": { | |
684 "$ref": "Empty" | |
685 }, | |
686 "scopes": [ | |
687 "https://www.googleapis.com/auth/cloud-platform"
, | |
688 "https://www.googleapis.com/auth/monitoring" | |
689 ] | |
690 } | |
691 }, | |
692 "resources": { | |
693 "members": { | |
694 "methods": { | |
695 "list": { | |
696 "description": "Lists the monitored resource
s that are members of a group.", | |
697 "httpMethod": "GET", | |
698 "id": "monitoring.projects.groups.members.li
st", | |
699 "parameterOrder": [ | |
700 "name" | |
701 ], | |
702 "parameters": { | |
703 "pageSize": { | |
704 "description": "A positive number th
at is the maximum number of results to return.", | |
705 "format": "int32", | |
706 "location": "query", | |
707 "type": "integer" | |
708 }, | |
709 "interval.startTime": { | |
710 "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.", | |
711 "format": "google-datetime", | |
712 "location": "query", | |
713 "type": "string" | |
714 }, | |
715 "name": { | |
716 "description": "The group whose memb
ers are listed. The format is \"projects/{project_id_or_number}/groups/{group_id
}\".", | |
717 "location": "path", | |
718 "pattern": "^projects/[^/]+/groups/[
^/]+$", | |
719 "required": true, | |
720 "type": "string" | |
721 }, | |
722 "interval.endTime": { | |
723 "description": "Required. The end of
the time interval.", | |
724 "format": "google-datetime", | |
725 "location": "query", | |
726 "type": "string" | |
727 }, | |
728 "filter": { | |
729 "description": "An optional list fil
ter describing the members to be returned. The filter may reference the type, la
bels, and metadata of monitored resources that comprise the group. For example,
to return only resources representing Compute Engine VM instances, use this filt
er:\nresource.type = \"gce_instance\"\n", | |
730 "location": "query", | |
731 "type": "string" | |
732 }, | |
733 "pageToken": { | |
734 "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.", | |
735 "location": "query", | |
736 "type": "string" | |
737 } | |
738 }, | |
739 "path": "v3/{+name}/members", | |
740 "response": { | |
741 "$ref": "ListGroupMembersResponse" | |
742 }, | |
743 "scopes": [ | |
744 "https://www.googleapis.com/auth/cloud-p
latform", | |
745 "https://www.googleapis.com/auth/monitor
ing", | |
746 "https://www.googleapis.com/auth/monitor
ing.read" | |
747 ] | |
748 } | |
749 } | |
750 } | 750 } |
751 } | 751 } |
752 } | 752 } |
753 } | 753 } |
754 } | 754 } |
755 }, | 755 }, |
756 "revision": "20170606", | 756 "revision": "20170701", |
757 "rootUrl": "https://monitoring.googleapis.com/", | 757 "rootUrl": "https://monitoring.googleapis.com/", |
758 "schemas": { | 758 "schemas": { |
759 "CollectdValue": { | |
760 "description": "A single data point from a collectd-based plugin.", | |
761 "id": "CollectdValue", | |
762 "properties": { | |
763 "value": { | |
764 "$ref": "TypedValue", | |
765 "description": "The measurement value." | |
766 }, | |
767 "dataSourceType": { | |
768 "description": "The type of measurement.", | |
769 "enum": [ | |
770 "UNSPECIFIED_DATA_SOURCE_TYPE", | |
771 "GAUGE", | |
772 "COUNTER", | |
773 "DERIVE", | |
774 "ABSOLUTE" | |
775 ], | |
776 "enumDescriptions": [ | |
777 "An unspecified data source type. This corresponds to go
ogle.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.", | |
778 "An instantaneous measurement of a varying quantity. Thi
s corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.", | |
779 "A cumulative value over time. This corresponds to googl
e.api.MetricDescriptor.MetricKind.CUMULATIVE.", | |
780 "A rate of change of the measurement.", | |
781 "An amount of change since the last measurement interval
. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA." | |
782 ], | |
783 "type": "string" | |
784 }, | |
785 "dataSourceName": { | |
786 "description": "The data source for the collectd value. For
example there are two data sources for network measurements: \"rx\" and \"tx\"."
, | |
787 "type": "string" | |
788 } | |
789 }, | |
790 "type": "object" | |
791 }, | |
792 "SourceContext": { | |
793 "description": "SourceContext represents information about the sourc
e of a protobuf element, like the file in which it is defined.", | |
794 "id": "SourceContext", | |
795 "properties": { | |
796 "fileName": { | |
797 "description": "The path-qualified name of the .proto file t
hat contained the associated protobuf element. For example: \"google/protobuf/so
urce_context.proto\".", | |
798 "type": "string" | |
799 } | |
800 }, | |
801 "type": "object" | |
802 }, | |
803 "MetricDescriptor": { | |
804 "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.", | |
805 "id": "MetricDescriptor", | |
806 "properties": { | |
807 "labels": { | |
808 "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.", | |
809 "items": { | |
810 "$ref": "LabelDescriptor" | |
811 }, | |
812 "type": "array" | |
813 }, | |
814 "name": { | |
815 "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 my-project-id:\n\"projects/my-project-id/metricDescriptors/custom.goo
gleapis.com%2Finvoice%2Fpaid%2Famount\"\n", | |
816 "type": "string" | |
817 }, | |
818 "type": { | |
819 "description": "The metric type, including its DNS name pref
ix. The type is not URL-encoded. All user-defined custom metric types have the D
NS name custom.googleapis.com. Metric types should use a natural hierarchical gr
ouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine
.googleapis.com/http/server/response_latencies\"\n", | |
820 "type": "string" | |
821 }, | |
822 "valueType": { | |
823 "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.", | |
824 "enum": [ | |
825 "VALUE_TYPE_UNSPECIFIED", | |
826 "BOOL", | |
827 "INT64", | |
828 "DOUBLE", | |
829 "STRING", | |
830 "DISTRIBUTION", | |
831 "MONEY" | |
832 ], | |
833 "enumDescriptions": [ | |
834 "Do not use this default value.", | |
835 "The value is a boolean. This value type can be used onl
y if the metric kind is GAUGE.", | |
836 "The value is a signed 64-bit integer.", | |
837 "The value is a double precision floating point number."
, | |
838 "The value is a text string. This value type can be used
only if the metric kind is GAUGE.", | |
839 "The value is a Distribution.", | |
840 "The value is money." | |
841 ], | |
842 "type": "string" | |
843 }, | |
844 "metricKind": { | |
845 "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.", | |
846 "enum": [ | |
847 "METRIC_KIND_UNSPECIFIED", | |
848 "GAUGE", | |
849 "DELTA", | |
850 "CUMULATIVE" | |
851 ], | |
852 "enumDescriptions": [ | |
853 "Do not use this default value.", | |
854 "An instantaneous measurement of a value.", | |
855 "The change in a value during a time interval.", | |
856 "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." | |
857 ], | |
858 "type": "string" | |
859 }, | |
860 "description": { | |
861 "description": "A detailed description of the metric, which
can be used in documentation.", | |
862 "type": "string" | |
863 }, | |
864 "displayName": { | |
865 "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\".", | |
866 "type": "string" | |
867 }, | |
868 "unit": { | |
869 "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 } { \"/\" Component } ;\n\nCompone
nt = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n
;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a com
ment if it follows a UNIT and is equivalent to 1 if it is used alone. For examp
les, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non
-blank printable ASCII characters not containing '{' or '}'.", | |
870 "type": "string" | |
871 } | |
872 }, | |
873 "type": "object" | |
874 }, | |
875 "Range": { | |
876 "description": "The range of the population values.", | |
877 "id": "Range", | |
878 "properties": { | |
879 "min": { | |
880 "description": "The minimum of the population values.", | |
881 "format": "double", | |
882 "type": "number" | |
883 }, | |
884 "max": { | |
885 "description": "The maximum of the population values.", | |
886 "format": "double", | |
887 "type": "number" | |
888 } | |
889 }, | |
890 "type": "object" | |
891 }, | |
892 "ListGroupsResponse": { | |
893 "description": "The ListGroups response.", | |
894 "id": "ListGroupsResponse", | |
895 "properties": { | |
896 "nextPageToken": { | |
897 "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.", | |
898 "type": "string" | |
899 }, | |
900 "group": { | |
901 "description": "The groups that match the specified filters.
", | |
902 "items": { | |
903 "$ref": "Group" | |
904 }, | |
905 "type": "array" | |
906 } | |
907 }, | |
908 "type": "object" | |
909 }, | |
910 "CreateCollectdTimeSeriesRequest": { | |
911 "description": "The CreateCollectdTimeSeries request.", | |
912 "id": "CreateCollectdTimeSeriesRequest", | |
913 "properties": { | |
914 "resource": { | |
915 "$ref": "MonitoredResource", | |
916 "description": "The monitored resource associated with the t
ime series." | |
917 }, | |
918 "collectdPayloads": { | |
919 "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.", | |
920 "items": { | |
921 "$ref": "CollectdPayload" | |
922 }, | |
923 "type": "array" | |
924 }, | |
925 "collectdVersion": { | |
926 "description": "The version of collectd that collected the d
ata. Example: \"5.3.0-192.el6\".", | |
927 "type": "string" | |
928 } | |
929 }, | |
930 "type": "object" | |
931 }, | |
932 "ListGroupMembersResponse": { | |
933 "description": "The ListGroupMembers response.", | |
934 "id": "ListGroupMembersResponse", | |
935 "properties": { | |
936 "members": { | |
937 "description": "A set of monitored resources in the group.", | |
938 "items": { | |
939 "$ref": "MonitoredResource" | |
940 }, | |
941 "type": "array" | |
942 }, | |
943 "nextPageToken": { | |
944 "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.", | |
945 "type": "string" | |
946 }, | |
947 "totalSize": { | |
948 "description": "The total number of elements matching this r
equest.", | |
949 "format": "int32", | |
950 "type": "integer" | |
951 } | |
952 }, | |
953 "type": "object" | |
954 }, | |
955 "ListMonitoredResourceDescriptorsResponse": { | |
956 "description": "The ListMonitoredResourceDescriptors response.", | |
957 "id": "ListMonitoredResourceDescriptorsResponse", | |
958 "properties": { | |
959 "nextPageToken": { | |
960 "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.", | |
961 "type": "string" | |
962 }, | |
963 "resourceDescriptors": { | |
964 "description": "The monitored resource descriptors that are
available to this project and that match filter, if present.", | |
965 "items": { | |
966 "$ref": "MonitoredResourceDescriptor" | |
967 }, | |
968 "type": "array" | |
969 } | |
970 }, | |
971 "type": "object" | |
972 }, | |
973 "TimeSeries": { | |
974 "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.", | |
975 "id": "TimeSeries", | |
976 "properties": { | |
977 "resource": { | |
978 "$ref": "MonitoredResource", | |
979 "description": "The associated monitored resource. Custom me
trics can use only certain monitored resource types in their time series data." | |
980 }, | |
981 "metricKind": { | |
982 "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.", | |
983 "enum": [ | |
984 "METRIC_KIND_UNSPECIFIED", | |
985 "GAUGE", | |
986 "DELTA", | |
987 "CUMULATIVE" | |
988 ], | |
989 "enumDescriptions": [ | |
990 "Do not use this default value.", | |
991 "An instantaneous measurement of a value.", | |
992 "The change in a value during a time interval.", | |
993 "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." | |
994 ], | |
995 "type": "string" | |
996 }, | |
997 "metric": { | |
998 "$ref": "Metric", | |
999 "description": "The associated metric. A fully-specified met
ric used to identify the time series." | |
1000 }, | |
1001 "points": { | |
1002 "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.", | |
1003 "items": { | |
1004 "$ref": "Point" | |
1005 }, | |
1006 "type": "array" | |
1007 }, | |
1008 "valueType": { | |
1009 "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.", | |
1010 "enum": [ | |
1011 "VALUE_TYPE_UNSPECIFIED", | |
1012 "BOOL", | |
1013 "INT64", | |
1014 "DOUBLE", | |
1015 "STRING", | |
1016 "DISTRIBUTION", | |
1017 "MONEY" | |
1018 ], | |
1019 "enumDescriptions": [ | |
1020 "Do not use this default value.", | |
1021 "The value is a boolean. This value type can be used onl
y if the metric kind is GAUGE.", | |
1022 "The value is a signed 64-bit integer.", | |
1023 "The value is a double precision floating point number."
, | |
1024 "The value is a text string. This value type can be used
only if the metric kind is GAUGE.", | |
1025 "The value is a Distribution.", | |
1026 "The value is money." | |
1027 ], | |
1028 "type": "string" | |
1029 } | |
1030 }, | |
1031 "type": "object" | |
1032 }, | |
1033 "CreateTimeSeriesRequest": { | 759 "CreateTimeSeriesRequest": { |
1034 "description": "The CreateTimeSeries request.", | 760 "description": "The CreateTimeSeries request.", |
1035 "id": "CreateTimeSeriesRequest", | 761 "id": "CreateTimeSeriesRequest", |
1036 "properties": { | 762 "properties": { |
1037 "timeSeries": { | 763 "timeSeries": { |
1038 "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.", | 764 "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.", |
1039 "items": { | 765 "items": { |
1040 "$ref": "TimeSeries" | 766 "$ref": "TimeSeries" |
1041 }, | 767 }, |
1042 "type": "array" | 768 "type": "array" |
1043 } | 769 } |
1044 }, | 770 }, |
1045 "type": "object" | 771 "type": "object" |
1046 }, | 772 }, |
1047 "Distribution": { | 773 "Distribution": { |
1048 "description": "Distribution contains summary statistics for a popul
ation of values. It optionally contains a histogram representing the distributio
n of those values across a set of buckets.The summary statistics are the count,
mean, sum of the squared deviation from the mean, the minimum, and the maximum o
f the set of population of values. The histogram is based on a sequence of bucke
ts and gives a count of values that fall into each bucket. The boundaries of the
buckets are given either explicitly or by formulas for buckets of fixed or expo
nentially increasing widths.Although it is not forbidden, it is generally a bad
idea to include non-finite values (infinities or NaNs) in the population of valu
es, as this will render the mean and sum_of_squared_deviation fields meaningless
.", | 774 "description": "Distribution contains summary statistics for a popul
ation of values. It optionally contains a histogram representing the distributio
n of those values across a set of buckets.The summary statistics are the count,
mean, sum of the squared deviation from the mean, the minimum, and the maximum o
f the set of population of values. The histogram is based on a sequence of bucke
ts and gives a count of values that fall into each bucket. The boundaries of the
buckets are given either explicitly or by formulas for buckets of fixed or expo
nentially increasing widths.Although it is not forbidden, it is generally a bad
idea to include non-finite values (infinities or NaNs) in the population of valu
es, as this will render the mean and sum_of_squared_deviation fields meaningless
.", |
1049 "id": "Distribution", | 775 "id": "Distribution", |
1050 "properties": { | 776 "properties": { |
1051 "sumOfSquaredDeviation": { | 777 "sumOfSquaredDeviation": { |
1052 "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.", | 778 "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.", |
1053 "format": "double", | 779 "format": "double", |
1054 "type": "number" | 780 "type": "number" |
1055 }, | 781 }, |
1056 "range": { | 782 "range": { |
1057 "$ref": "Range", | 783 "$ref": "Range", |
1058 "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." | 784 "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." |
1059 }, | 785 }, |
| 786 "count": { |
| 787 "description": "The number of values in the population. Must
be non-negative. This value must equal the sum of the values in bucket_counts i
f a histogram is provided.", |
| 788 "format": "int64", |
| 789 "type": "string" |
| 790 }, |
1060 "mean": { | 791 "mean": { |
1061 "description": "The arithmetic mean of the values in the pop
ulation. If count is zero then this field must be zero.", | 792 "description": "The arithmetic mean of the values in the pop
ulation. If count is zero then this field must be zero.", |
1062 "format": "double", | 793 "format": "double", |
1063 "type": "number" | 794 "type": "number" |
1064 }, | 795 }, |
1065 "count": { | |
1066 "description": "The number of values in the population. Must
be non-negative. This value must equal the sum of the values in bucket_counts i
f a histogram is provided.", | |
1067 "format": "int64", | |
1068 "type": "string" | |
1069 }, | |
1070 "bucketCounts": { | 796 "bucketCounts": { |
1071 "description": "Required in the Stackdriver Monitoring API v
3. The values for each bucket specified in bucket_options. The sum of the values
in bucketCounts must equal the value in the count field of the Distribution obj
ect. The order of the bucket counts follows the numbering schemes described for
the three bucket types. The underflow bucket has number 0; the finite buckets, i
f any, have numbers 1 through N-2; and the overflow bucket has number N-1. The s
ize of bucket_counts must not be greater than N. If the size is less than N, the
n the remaining buckets are assigned values of zero.", | 797 "description": "Required in the Stackdriver Monitoring API v
3. The values for each bucket specified in bucket_options. The sum of the values
in bucketCounts must equal the value in the count field of the Distribution obj
ect. The order of the bucket counts follows the numbering schemes described for
the three bucket types. The underflow bucket has number 0; the finite buckets, i
f any, have numbers 1 through N-2; and the overflow bucket has number N-1. The s
ize of bucket_counts must not be greater than N. If the size is less than N, the
n the remaining buckets are assigned values of zero.", |
1072 "items": { | 798 "items": { |
1073 "format": "int64", | 799 "format": "int64", |
1074 "type": "string" | 800 "type": "string" |
1075 }, | 801 }, |
1076 "type": "array" | 802 "type": "array" |
1077 }, | 803 }, |
1078 "bucketOptions": { | 804 "bucketOptions": { |
1079 "$ref": "BucketOptions", | 805 "$ref": "BucketOptions", |
(...skipping 17 matching lines...) Expand all Loading... |
1097 "description": "Required. Values for all of the labels liste
d in the associated monitored resource descriptor. For example, Compute Engine V
M instances use the labels \"project_id\", \"instance_id\", and \"zone\".", | 823 "description": "Required. Values for all of the labels liste
d in the associated monitored resource descriptor. For example, Compute Engine V
M instances use the labels \"project_id\", \"instance_id\", and \"zone\".", |
1098 "type": "object" | 824 "type": "object" |
1099 } | 825 } |
1100 }, | 826 }, |
1101 "type": "object" | 827 "type": "object" |
1102 }, | 828 }, |
1103 "ListMetricDescriptorsResponse": { | 829 "ListMetricDescriptorsResponse": { |
1104 "description": "The ListMetricDescriptors response.", | 830 "description": "The ListMetricDescriptors response.", |
1105 "id": "ListMetricDescriptorsResponse", | 831 "id": "ListMetricDescriptorsResponse", |
1106 "properties": { | 832 "properties": { |
| 833 "nextPageToken": { |
| 834 "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.", |
| 835 "type": "string" |
| 836 }, |
1107 "metricDescriptors": { | 837 "metricDescriptors": { |
1108 "description": "The metric descriptors that are available to
the project and that match the value of filter, if present.", | 838 "description": "The metric descriptors that are available to
the project and that match the value of filter, if present.", |
1109 "items": { | 839 "items": { |
1110 "$ref": "MetricDescriptor" | 840 "$ref": "MetricDescriptor" |
1111 }, | 841 }, |
1112 "type": "array" | 842 "type": "array" |
1113 }, | |
1114 "nextPageToken": { | |
1115 "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.", | |
1116 "type": "string" | |
1117 } | 843 } |
1118 }, | 844 }, |
1119 "type": "object" | 845 "type": "object" |
1120 }, | 846 }, |
1121 "MonitoredResourceDescriptor": { | 847 "MonitoredResourceDescriptor": { |
1122 "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_i
nstance\" and specifies the use of the labels \"instance_id\" and \"zone\" to id
entify particular VM instances.Different APIs can support different monitored re
source types. APIs generally provide a list method that returns the monitored re
source descriptors used by the API.", | 848 "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_i
nstance\" and specifies the use of the labels \"instance_id\" and \"zone\" to id
entify particular VM instances.Different APIs can support different monitored re
source types. APIs generally provide a list method that returns the monitored re
source descriptors used by the API.", |
1123 "id": "MonitoredResourceDescriptor", | 849 "id": "MonitoredResourceDescriptor", |
1124 "properties": { | 850 "properties": { |
| 851 "name": { |
| 852 "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 {project_id}
is a project ID that provides API-specific context for accessing the type. APIs
that do not use project information can use the resource name format \"monitored
ResourceDescriptors/{type}\".", |
| 853 "type": "string" |
| 854 }, |
| 855 "description": { |
| 856 "description": "Optional. A detailed description of the moni
tored resource type that might be used in documentation.", |
| 857 "type": "string" |
| 858 }, |
| 859 "displayName": { |
| 860 "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, \"Google
Cloud SQL Database\".", |
| 861 "type": "string" |
| 862 }, |
| 863 "type": { |
| 864 "description": "Required. The monitored resource type. For e
xample, the type \"cloudsql_database\" represents databases in Google Cloud SQL.
The maximum length of this value is 256 characters.", |
| 865 "type": "string" |
| 866 }, |
1125 "labels": { | 867 "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 \"zone
\".", | 868 "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 \"zone
\".", |
1127 "items": { | 869 "items": { |
1128 "$ref": "LabelDescriptor" | 870 "$ref": "LabelDescriptor" |
1129 }, | 871 }, |
1130 "type": "array" | 872 "type": "array" |
1131 }, | |
1132 "name": { | |
1133 "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 {project_id}
is a project ID that provides API-specific context for accessing the type. APIs
that do not use project information can use the resource name format \"monitored
ResourceDescriptors/{type}\".", | |
1134 "type": "string" | |
1135 }, | |
1136 "displayName": { | |
1137 "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, \"Google
Cloud SQL Database\".", | |
1138 "type": "string" | |
1139 }, | |
1140 "description": { | |
1141 "description": "Optional. A detailed description of the moni
tored resource type that might be used in documentation.", | |
1142 "type": "string" | |
1143 }, | |
1144 "type": { | |
1145 "description": "Required. The monitored resource type. For e
xample, the type \"cloudsql_database\" represents databases in Google Cloud SQL.
The maximum length of this value is 256 characters.", | |
1146 "type": "string" | |
1147 } | 873 } |
1148 }, | 874 }, |
1149 "type": "object" | 875 "type": "object" |
1150 }, | 876 }, |
1151 "TypedValue": { | 877 "TypedValue": { |
1152 "description": "A single strongly-typed value.", | 878 "description": "A single strongly-typed value.", |
1153 "id": "TypedValue", | 879 "id": "TypedValue", |
1154 "properties": { | 880 "properties": { |
| 881 "stringValue": { |
| 882 "description": "A variable-length string value.", |
| 883 "type": "string" |
| 884 }, |
| 885 "boolValue": { |
| 886 "description": "A Boolean value: true or false.", |
| 887 "type": "boolean" |
| 888 }, |
1155 "doubleValue": { | 889 "doubleValue": { |
1156 "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.", | 890 "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.", |
1157 "format": "double", | 891 "format": "double", |
1158 "type": "number" | 892 "type": "number" |
1159 }, | 893 }, |
1160 "int64Value": { | 894 "int64Value": { |
1161 "description": "A 64-bit integer. Its range is approximately
±9.2x10<sup>18</sup>.", | 895 "description": "A 64-bit integer. Its range is approximately
±9.2x10<sup>18</sup>.", |
1162 "format": "int64", | 896 "format": "int64", |
1163 "type": "string" | 897 "type": "string" |
1164 }, | 898 }, |
1165 "distributionValue": { | 899 "distributionValue": { |
1166 "$ref": "Distribution", | 900 "$ref": "Distribution", |
1167 "description": "A distribution value." | 901 "description": "A distribution value." |
1168 }, | |
1169 "boolValue": { | |
1170 "description": "A Boolean value: true or false.", | |
1171 "type": "boolean" | |
1172 }, | |
1173 "stringValue": { | |
1174 "description": "A variable-length string value.", | |
1175 "type": "string" | |
1176 } | 902 } |
1177 }, | 903 }, |
1178 "type": "object" | 904 "type": "object" |
1179 }, | 905 }, |
1180 "CollectdPayload": { | 906 "CollectdPayload": { |
1181 "description": "A collection of data points sent from a collectd-bas
ed plugin. See the collectd documentation for more information.", | 907 "description": "A collection of data points sent from a collectd-bas
ed plugin. See the collectd documentation for more information.", |
1182 "id": "CollectdPayload", | 908 "id": "CollectdPayload", |
1183 "properties": { | 909 "properties": { |
| 910 "typeInstance": { |
| 911 "description": "The measurement type instance. Example: \"us
ed\".", |
| 912 "type": "string" |
| 913 }, |
| 914 "metadata": { |
| 915 "additionalProperties": { |
| 916 "$ref": "TypedValue" |
| 917 }, |
| 918 "description": "The measurement metadata. Example: \"process
_id\" -> 12345", |
| 919 "type": "object" |
| 920 }, |
| 921 "type": { |
| 922 "description": "The measurement type. Example: \"memory\".", |
| 923 "type": "string" |
| 924 }, |
1184 "plugin": { | 925 "plugin": { |
1185 "description": "The name of the plugin. Example: \"disk\".", | 926 "description": "The name of the plugin. Example: \"disk\".", |
1186 "type": "string" | 927 "type": "string" |
1187 }, | 928 }, |
1188 "pluginInstance": { | 929 "pluginInstance": { |
1189 "description": "The instance name of the plugin Example: \"h
dcl\".", | 930 "description": "The instance name of the plugin Example: \"h
dcl\".", |
1190 "type": "string" | 931 "type": "string" |
1191 }, | 932 }, |
1192 "endTime": { | 933 "endTime": { |
1193 "description": "The end time of the interval.", | 934 "description": "The end time of the interval.", |
1194 "format": "google-datetime", | 935 "format": "google-datetime", |
1195 "type": "string" | 936 "type": "string" |
1196 }, | 937 }, |
1197 "startTime": { | 938 "startTime": { |
1198 "description": "The start time of the interval.", | 939 "description": "The start time of the interval.", |
1199 "format": "google-datetime", | 940 "format": "google-datetime", |
1200 "type": "string" | 941 "type": "string" |
1201 }, | 942 }, |
1202 "values": { | 943 "values": { |
1203 "description": "The measured values during this time interva
l. Each value must have a different dataSourceName.", | 944 "description": "The measured values during this time interva
l. Each value must have a different dataSourceName.", |
1204 "items": { | 945 "items": { |
1205 "$ref": "CollectdValue" | 946 "$ref": "CollectdValue" |
1206 }, | 947 }, |
1207 "type": "array" | 948 "type": "array" |
1208 }, | |
1209 "typeInstance": { | |
1210 "description": "The measurement type instance. Example: \"us
ed\".", | |
1211 "type": "string" | |
1212 }, | |
1213 "metadata": { | |
1214 "additionalProperties": { | |
1215 "$ref": "TypedValue" | |
1216 }, | |
1217 "description": "The measurement metadata. Example: \"process
_id\" -> 12345", | |
1218 "type": "object" | |
1219 }, | |
1220 "type": { | |
1221 "description": "The measurement type. Example: \"memory\".", | |
1222 "type": "string" | |
1223 } | 949 } |
1224 }, | 950 }, |
1225 "type": "object" | 951 "type": "object" |
1226 }, | 952 }, |
1227 "Linear": { | 953 "Linear": { |
1228 "description": "Specifies a linear sequence of buckets that all have
the same width (except overflow and underflow). Each bucket represents a consta
nt absolute uncertainty on the specific value in the bucket.There are num_finite
_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0
<= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width *
(i - 1)).", | 954 "description": "Specifies a linear sequence of buckets that all have
the same width (except overflow and underflow). Each bucket represents a consta
nt absolute uncertainty on the specific value in the bucket.There are num_finite
_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0
<= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width *
(i - 1)).", |
1229 "id": "Linear", | 955 "id": "Linear", |
1230 "properties": { | 956 "properties": { |
1231 "width": { | |
1232 "description": "Must be greater than 0.", | |
1233 "format": "double", | |
1234 "type": "number" | |
1235 }, | |
1236 "offset": { | 957 "offset": { |
1237 "description": "Lower bound of the first bucket.", | 958 "description": "Lower bound of the first bucket.", |
1238 "format": "double", | 959 "format": "double", |
1239 "type": "number" | 960 "type": "number" |
1240 }, | 961 }, |
1241 "numFiniteBuckets": { | 962 "numFiniteBuckets": { |
1242 "description": "Must be greater than 0.", | 963 "description": "Must be greater than 0.", |
1243 "format": "int32", | 964 "format": "int32", |
1244 "type": "integer" | 965 "type": "integer" |
| 966 }, |
| 967 "width": { |
| 968 "description": "Must be greater than 0.", |
| 969 "format": "double", |
| 970 "type": "number" |
1245 } | 971 } |
1246 }, | 972 }, |
1247 "type": "object" | 973 "type": "object" |
1248 }, | 974 }, |
1249 "Option": { | 975 "Option": { |
1250 "description": "A protocol buffer option, which can be attached to a
message, field, enumeration, etc.", | 976 "description": "A protocol buffer option, which can be attached to a
message, field, enumeration, etc.", |
1251 "id": "Option", | 977 "id": "Option", |
1252 "properties": { | 978 "properties": { |
1253 "value": { | 979 "value": { |
1254 "additionalProperties": { | 980 "additionalProperties": { |
(...skipping 100 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1355 "description": "The set of label values that uniquely identi
fy this metric. All labels listed in the MetricDescriptor must be assigned value
s.", | 1081 "description": "The set of label values that uniquely identi
fy this metric. All labels listed in the MetricDescriptor must be assigned value
s.", |
1356 "type": "object" | 1082 "type": "object" |
1357 } | 1083 } |
1358 }, | 1084 }, |
1359 "type": "object" | 1085 "type": "object" |
1360 }, | 1086 }, |
1361 "Field": { | 1087 "Field": { |
1362 "description": "A single field of a message type.", | 1088 "description": "A single field of a message type.", |
1363 "id": "Field", | 1089 "id": "Field", |
1364 "properties": { | 1090 "properties": { |
| 1091 "typeUrl": { |
| 1092 "description": "The field type URL, without the scheme, for
message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Tim
estamp\".", |
| 1093 "type": "string" |
| 1094 }, |
| 1095 "number": { |
| 1096 "description": "The field number.", |
| 1097 "format": "int32", |
| 1098 "type": "integer" |
| 1099 }, |
1365 "jsonName": { | 1100 "jsonName": { |
1366 "description": "The field JSON name.", | 1101 "description": "The field JSON name.", |
1367 "type": "string" | 1102 "type": "string" |
1368 }, | 1103 }, |
1369 "kind": { | 1104 "kind": { |
1370 "description": "The field type.", | 1105 "description": "The field type.", |
1371 "enum": [ | 1106 "enum": [ |
1372 "TYPE_UNKNOWN", | 1107 "TYPE_UNKNOWN", |
1373 "TYPE_DOUBLE", | 1108 "TYPE_DOUBLE", |
1374 "TYPE_FLOAT", | 1109 "TYPE_FLOAT", |
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1417 "items": { | 1152 "items": { |
1418 "$ref": "Option" | 1153 "$ref": "Option" |
1419 }, | 1154 }, |
1420 "type": "array" | 1155 "type": "array" |
1421 }, | 1156 }, |
1422 "oneofIndex": { | 1157 "oneofIndex": { |
1423 "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.", | 1158 "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.", |
1424 "format": "int32", | 1159 "format": "int32", |
1425 "type": "integer" | 1160 "type": "integer" |
1426 }, | 1161 }, |
| 1162 "packed": { |
| 1163 "description": "Whether to use alternative packed wire repre
sentation.", |
| 1164 "type": "boolean" |
| 1165 }, |
1427 "cardinality": { | 1166 "cardinality": { |
1428 "description": "The field cardinality.", | 1167 "description": "The field cardinality.", |
1429 "enum": [ | 1168 "enum": [ |
1430 "CARDINALITY_UNKNOWN", | 1169 "CARDINALITY_UNKNOWN", |
1431 "CARDINALITY_OPTIONAL", | 1170 "CARDINALITY_OPTIONAL", |
1432 "CARDINALITY_REQUIRED", | 1171 "CARDINALITY_REQUIRED", |
1433 "CARDINALITY_REPEATED" | 1172 "CARDINALITY_REPEATED" |
1434 ], | 1173 ], |
1435 "enumDescriptions": [ | 1174 "enumDescriptions": [ |
1436 "For fields with unknown cardinality.", | 1175 "For fields with unknown cardinality.", |
1437 "For optional fields.", | 1176 "For optional fields.", |
1438 "For required fields. Proto2 syntax only.", | 1177 "For required fields. Proto2 syntax only.", |
1439 "For repeated fields." | 1178 "For repeated fields." |
1440 ], | 1179 ], |
1441 "type": "string" | 1180 "type": "string" |
1442 }, | 1181 }, |
1443 "packed": { | |
1444 "description": "Whether to use alternative packed wire repre
sentation.", | |
1445 "type": "boolean" | |
1446 }, | |
1447 "defaultValue": { | 1182 "defaultValue": { |
1448 "description": "The string value of the default value of thi
s field. Proto2 syntax only.", | 1183 "description": "The string value of the default value of thi
s field. Proto2 syntax only.", |
1449 "type": "string" | 1184 "type": "string" |
1450 }, | 1185 }, |
1451 "name": { | 1186 "name": { |
1452 "description": "The field name.", | 1187 "description": "The field name.", |
1453 "type": "string" | 1188 "type": "string" |
1454 }, | 1189 } |
1455 "typeUrl": { | 1190 }, |
1456 "description": "The field type URL, without the scheme, for
message or enumeration types. Example: \"type.googleapis.com/google.protobuf.Tim
estamp\".", | 1191 "type": "object" |
1457 "type": "string" | 1192 }, |
1458 }, | 1193 "LabelDescriptor": { |
1459 "number": { | 1194 "description": "A description of a label.", |
1460 "description": "The field number.", | 1195 "id": "LabelDescriptor", |
1461 "format": "int32", | 1196 "properties": { |
1462 "type": "integer" | 1197 "key": { |
| 1198 "description": "The label key.", |
| 1199 "type": "string" |
| 1200 }, |
| 1201 "description": { |
| 1202 "description": "A human-readable description for the label."
, |
| 1203 "type": "string" |
| 1204 }, |
| 1205 "valueType": { |
| 1206 "description": "The type of data that can be assigned to the
label.", |
| 1207 "enum": [ |
| 1208 "STRING", |
| 1209 "BOOL", |
| 1210 "INT64" |
| 1211 ], |
| 1212 "enumDescriptions": [ |
| 1213 "A variable-length string. This is the default.", |
| 1214 "Boolean; true or false.", |
| 1215 "A 64-bit signed integer." |
| 1216 ], |
| 1217 "type": "string" |
1463 } | 1218 } |
1464 }, | 1219 }, |
1465 "type": "object" | 1220 "type": "object" |
1466 }, | 1221 }, |
1467 "ListTimeSeriesResponse": { | 1222 "ListTimeSeriesResponse": { |
1468 "description": "The ListTimeSeries response.", | 1223 "description": "The ListTimeSeries response.", |
1469 "id": "ListTimeSeriesResponse", | 1224 "id": "ListTimeSeriesResponse", |
1470 "properties": { | 1225 "properties": { |
1471 "timeSeries": { | 1226 "timeSeries": { |
1472 "description": "One or more time series that match the filte
r included in the request.", | 1227 "description": "One or more time series that match the filte
r included in the request.", |
1473 "items": { | 1228 "items": { |
1474 "$ref": "TimeSeries" | 1229 "$ref": "TimeSeries" |
1475 }, | 1230 }, |
1476 "type": "array" | 1231 "type": "array" |
1477 }, | 1232 }, |
| 1233 "nextPageToken": { |
| 1234 "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.", |
| 1235 "type": "string" |
| 1236 } |
| 1237 }, |
| 1238 "type": "object" |
| 1239 }, |
| 1240 "Type": { |
| 1241 "description": "A protocol buffer message type.", |
| 1242 "id": "Type", |
| 1243 "properties": { |
| 1244 "options": { |
| 1245 "description": "The protocol buffer options.", |
| 1246 "items": { |
| 1247 "$ref": "Option" |
| 1248 }, |
| 1249 "type": "array" |
| 1250 }, |
| 1251 "fields": { |
| 1252 "description": "The list of fields.", |
| 1253 "items": { |
| 1254 "$ref": "Field" |
| 1255 }, |
| 1256 "type": "array" |
| 1257 }, |
| 1258 "name": { |
| 1259 "description": "The fully qualified message name.", |
| 1260 "type": "string" |
| 1261 }, |
| 1262 "oneofs": { |
| 1263 "description": "The list of types appearing in oneof definit
ions in this type.", |
| 1264 "items": { |
| 1265 "type": "string" |
| 1266 }, |
| 1267 "type": "array" |
| 1268 }, |
| 1269 "sourceContext": { |
| 1270 "$ref": "SourceContext", |
| 1271 "description": "The source context." |
| 1272 }, |
| 1273 "syntax": { |
| 1274 "description": "The source syntax.", |
| 1275 "enum": [ |
| 1276 "SYNTAX_PROTO2", |
| 1277 "SYNTAX_PROTO3" |
| 1278 ], |
| 1279 "enumDescriptions": [ |
| 1280 "Syntax proto2.", |
| 1281 "Syntax proto3." |
| 1282 ], |
| 1283 "type": "string" |
| 1284 } |
| 1285 }, |
| 1286 "type": "object" |
| 1287 }, |
| 1288 "Group": { |
| 1289 "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 filter, environmen
t=\"production\". A child of that parent group has a filter, role=\"transcoder\"
. The parent group contains all instances in the production environment, regardl
ess of their roles. The child group contains instances that have the transcoder
role and are in the production environment.The monitored resources contained in
a group can change at any moment, depending on what resources exist and what fil
ters are associated with the group and its ancestors.", |
| 1290 "id": "Group", |
| 1291 "properties": { |
| 1292 "isCluster": { |
| 1293 "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.", |
| 1294 "type": "boolean" |
| 1295 }, |
| 1296 "filter": { |
| 1297 "description": "The filter used to determine which monitored
resources belong to this group.", |
| 1298 "type": "string" |
| 1299 }, |
| 1300 "parentName": { |
| 1301 "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 grou
ps with no parent, parentName is the empty string, \"\".", |
| 1302 "type": "string" |
| 1303 }, |
| 1304 "name": { |
| 1305 "description": "Output only. The name of this group. The for
mat is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a gr
oup, this field is ignored and a new name is created consisting of the project s
pecified in the call to CreateGroup and a unique {group_id} that is generated au
tomatically.", |
| 1306 "type": "string" |
| 1307 }, |
| 1308 "displayName": { |
| 1309 "description": "A user-assigned name for this group, used on
ly for display purposes.", |
| 1310 "type": "string" |
| 1311 } |
| 1312 }, |
| 1313 "type": "object" |
| 1314 }, |
| 1315 "BucketOptions": { |
| 1316 "description": "BucketOptions describes the bucket boundaries used t
o create a histogram for the distribution. The buckets can be in a linear sequen
ce, an exponential sequence, or each bucket can be specified explicitly. BucketO
ptions does not include the number of values in each bucket.A bucket has an incl
usive lower bound and exclusive upper bound for the values that are counted for
that bucket. The upper bound of a bucket must be strictly greater than the lower
bound. The sequence of N buckets for a distribution consists of an underflow bu
cket (number 0), zero or more finite buckets (number 1 through N - 2) and an ove
rflow bucket (number N - 1). The buckets are contiguous: the lower bound of buck
et i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span th
e whole range of finite values: lower bound of the underflow bucket is -infinity
and the upper bound of the overflow bucket is +infinity. The finite buckets are
so-called because both bounds are finite.", |
| 1317 "id": "BucketOptions", |
| 1318 "properties": { |
| 1319 "explicitBuckets": { |
| 1320 "$ref": "Explicit", |
| 1321 "description": "The explicit buckets." |
| 1322 }, |
| 1323 "linearBuckets": { |
| 1324 "$ref": "Linear", |
| 1325 "description": "The linear bucket." |
| 1326 }, |
| 1327 "exponentialBuckets": { |
| 1328 "$ref": "Exponential", |
| 1329 "description": "The exponential buckets." |
| 1330 } |
| 1331 }, |
| 1332 "type": "object" |
| 1333 }, |
| 1334 "CollectdValue": { |
| 1335 "description": "A single data point from a collectd-based plugin.", |
| 1336 "id": "CollectdValue", |
| 1337 "properties": { |
| 1338 "value": { |
| 1339 "$ref": "TypedValue", |
| 1340 "description": "The measurement value." |
| 1341 }, |
| 1342 "dataSourceType": { |
| 1343 "description": "The type of measurement.", |
| 1344 "enum": [ |
| 1345 "UNSPECIFIED_DATA_SOURCE_TYPE", |
| 1346 "GAUGE", |
| 1347 "COUNTER", |
| 1348 "DERIVE", |
| 1349 "ABSOLUTE" |
| 1350 ], |
| 1351 "enumDescriptions": [ |
| 1352 "An unspecified data source type. This corresponds to go
ogle.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.", |
| 1353 "An instantaneous measurement of a varying quantity. Thi
s corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.", |
| 1354 "A cumulative value over time. This corresponds to googl
e.api.MetricDescriptor.MetricKind.CUMULATIVE.", |
| 1355 "A rate of change of the measurement.", |
| 1356 "An amount of change since the last measurement interval
. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA." |
| 1357 ], |
| 1358 "type": "string" |
| 1359 }, |
| 1360 "dataSourceName": { |
| 1361 "description": "The data source for the collectd value. For
example there are two data sources for network measurements: \"rx\" and \"tx\"."
, |
| 1362 "type": "string" |
| 1363 } |
| 1364 }, |
| 1365 "type": "object" |
| 1366 }, |
| 1367 "MetricDescriptor": { |
| 1368 "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.", |
| 1369 "id": "MetricDescriptor", |
| 1370 "properties": { |
| 1371 "name": { |
| 1372 "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 my-project-id:\n\"projects/my-project-id/metricDescriptors/custom.goo
gleapis.com%2Finvoice%2Fpaid%2Famount\"\n", |
| 1373 "type": "string" |
| 1374 }, |
| 1375 "type": { |
| 1376 "description": "The metric type, including its DNS name pref
ix. The type is not URL-encoded. All user-defined custom metric types have the D
NS name custom.googleapis.com. Metric types should use a natural hierarchical gr
ouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine
.googleapis.com/http/server/response_latencies\"\n", |
| 1377 "type": "string" |
| 1378 }, |
| 1379 "valueType": { |
| 1380 "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.", |
| 1381 "enum": [ |
| 1382 "VALUE_TYPE_UNSPECIFIED", |
| 1383 "BOOL", |
| 1384 "INT64", |
| 1385 "DOUBLE", |
| 1386 "STRING", |
| 1387 "DISTRIBUTION", |
| 1388 "MONEY" |
| 1389 ], |
| 1390 "enumDescriptions": [ |
| 1391 "Do not use this default value.", |
| 1392 "The value is a boolean. This value type can be used onl
y if the metric kind is GAUGE.", |
| 1393 "The value is a signed 64-bit integer.", |
| 1394 "The value is a double precision floating point number."
, |
| 1395 "The value is a text string. This value type can be used
only if the metric kind is GAUGE.", |
| 1396 "The value is a Distribution.", |
| 1397 "The value is money." |
| 1398 ], |
| 1399 "type": "string" |
| 1400 }, |
| 1401 "metricKind": { |
| 1402 "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.", |
| 1403 "enum": [ |
| 1404 "METRIC_KIND_UNSPECIFIED", |
| 1405 "GAUGE", |
| 1406 "DELTA", |
| 1407 "CUMULATIVE" |
| 1408 ], |
| 1409 "enumDescriptions": [ |
| 1410 "Do not use this default value.", |
| 1411 "An instantaneous measurement of a value.", |
| 1412 "The change in a value during a time interval.", |
| 1413 "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." |
| 1414 ], |
| 1415 "type": "string" |
| 1416 }, |
| 1417 "description": { |
| 1418 "description": "A detailed description of the metric, which
can be used in documentation.", |
| 1419 "type": "string" |
| 1420 }, |
| 1421 "displayName": { |
| 1422 "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\".", |
| 1423 "type": "string" |
| 1424 }, |
| 1425 "unit": { |
| 1426 "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 } { \"/\" Component } ;\n\nCompone
nt = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n
;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a com
ment if it follows a UNIT and is equivalent to 1 if it is used alone. For examp
les, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non
-blank printable ASCII characters not containing '{' or '}'.", |
| 1427 "type": "string" |
| 1428 }, |
| 1429 "labels": { |
| 1430 "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.", |
| 1431 "items": { |
| 1432 "$ref": "LabelDescriptor" |
| 1433 }, |
| 1434 "type": "array" |
| 1435 } |
| 1436 }, |
| 1437 "type": "object" |
| 1438 }, |
| 1439 "SourceContext": { |
| 1440 "description": "SourceContext represents information about the sourc
e of a protobuf element, like the file in which it is defined.", |
| 1441 "id": "SourceContext", |
| 1442 "properties": { |
| 1443 "fileName": { |
| 1444 "description": "The path-qualified name of the .proto file t
hat contained the associated protobuf element. For example: \"google/protobuf/so
urce_context.proto\".", |
| 1445 "type": "string" |
| 1446 } |
| 1447 }, |
| 1448 "type": "object" |
| 1449 }, |
| 1450 "Range": { |
| 1451 "description": "The range of the population values.", |
| 1452 "id": "Range", |
| 1453 "properties": { |
| 1454 "min": { |
| 1455 "description": "The minimum of the population values.", |
| 1456 "format": "double", |
| 1457 "type": "number" |
| 1458 }, |
| 1459 "max": { |
| 1460 "description": "The maximum of the population values.", |
| 1461 "format": "double", |
| 1462 "type": "number" |
| 1463 } |
| 1464 }, |
| 1465 "type": "object" |
| 1466 }, |
| 1467 "ListGroupsResponse": { |
| 1468 "description": "The ListGroups response.", |
| 1469 "id": "ListGroupsResponse", |
| 1470 "properties": { |
| 1471 "group": { |
| 1472 "description": "The groups that match the specified filters.
", |
| 1473 "items": { |
| 1474 "$ref": "Group" |
| 1475 }, |
| 1476 "type": "array" |
| 1477 }, |
1478 "nextPageToken": { | 1478 "nextPageToken": { |
1479 "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.", | 1479 "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.", |
1480 "type": "string" | 1480 "type": "string" |
1481 } | 1481 } |
1482 }, | 1482 }, |
1483 "type": "object" | 1483 "type": "object" |
1484 }, | 1484 }, |
1485 "LabelDescriptor": { | 1485 "ListGroupMembersResponse": { |
1486 "description": "A description of a label.", | 1486 "description": "The ListGroupMembers response.", |
1487 "id": "LabelDescriptor", | 1487 "id": "ListGroupMembersResponse", |
1488 "properties": { | 1488 "properties": { |
1489 "key": { | 1489 "nextPageToken": { |
1490 "description": "The label key.", | 1490 "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.", |
1491 "type": "string" | 1491 "type": "string" |
1492 }, | 1492 }, |
1493 "description": { | 1493 "totalSize": { |
1494 "description": "A human-readable description for the label."
, | 1494 "description": "The total number of elements matching this r
equest.", |
1495 "type": "string" | 1495 "format": "int32", |
| 1496 "type": "integer" |
1496 }, | 1497 }, |
1497 "valueType": { | 1498 "members": { |
1498 "description": "The type of data that can be assigned to the
label.", | 1499 "description": "A set of monitored resources in the group.", |
1499 "enum": [ | 1500 "items": { |
1500 "STRING", | 1501 "$ref": "MonitoredResource" |
1501 "BOOL", | 1502 }, |
1502 "INT64" | 1503 "type": "array" |
1503 ], | |
1504 "enumDescriptions": [ | |
1505 "A variable-length string. This is the default.", | |
1506 "Boolean; true or false.", | |
1507 "A 64-bit signed integer." | |
1508 ], | |
1509 "type": "string" | |
1510 } | 1504 } |
1511 }, | 1505 }, |
1512 "type": "object" | 1506 "type": "object" |
1513 }, | 1507 }, |
1514 "Type": { | 1508 "CreateCollectdTimeSeriesRequest": { |
1515 "description": "A protocol buffer message type.", | 1509 "description": "The CreateCollectdTimeSeries request.", |
1516 "id": "Type", | 1510 "id": "CreateCollectdTimeSeriesRequest", |
1517 "properties": { | 1511 "properties": { |
1518 "oneofs": { | 1512 "collectdVersion": { |
1519 "description": "The list of types appearing in oneof definit
ions in this type.", | 1513 "description": "The version of collectd that collected the d
ata. Example: \"5.3.0-192.el6\".", |
| 1514 "type": "string" |
| 1515 }, |
| 1516 "collectdPayloads": { |
| 1517 "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.", |
1520 "items": { | 1518 "items": { |
1521 "type": "string" | 1519 "$ref": "CollectdPayload" |
1522 }, | 1520 }, |
1523 "type": "array" | 1521 "type": "array" |
1524 }, | 1522 }, |
1525 "sourceContext": { | 1523 "resource": { |
1526 "$ref": "SourceContext", | 1524 "$ref": "MonitoredResource", |
1527 "description": "The source context." | 1525 "description": "The monitored resource associated with the t
ime series." |
1528 }, | |
1529 "syntax": { | |
1530 "description": "The source syntax.", | |
1531 "enum": [ | |
1532 "SYNTAX_PROTO2", | |
1533 "SYNTAX_PROTO3" | |
1534 ], | |
1535 "enumDescriptions": [ | |
1536 "Syntax proto2.", | |
1537 "Syntax proto3." | |
1538 ], | |
1539 "type": "string" | |
1540 }, | |
1541 "options": { | |
1542 "description": "The protocol buffer options.", | |
1543 "items": { | |
1544 "$ref": "Option" | |
1545 }, | |
1546 "type": "array" | |
1547 }, | |
1548 "fields": { | |
1549 "description": "The list of fields.", | |
1550 "items": { | |
1551 "$ref": "Field" | |
1552 }, | |
1553 "type": "array" | |
1554 }, | |
1555 "name": { | |
1556 "description": "The fully qualified message name.", | |
1557 "type": "string" | |
1558 } | 1526 } |
1559 }, | 1527 }, |
1560 "type": "object" | 1528 "type": "object" |
1561 }, | 1529 }, |
1562 "Group": { | 1530 "ListMonitoredResourceDescriptorsResponse": { |
1563 "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 filter, environmen
t=\"production\". A child of that parent group has a filter, role=\"transcoder\"
. The parent group contains all instances in the production environment, regardl
ess of their roles. The child group contains instances that have the transcoder
role and are in the production environment.The monitored resources contained in
a group can change at any moment, depending on what resources exist and what fil
ters are associated with the group and its ancestors.", | 1531 "description": "The ListMonitoredResourceDescriptors response.", |
1564 "id": "Group", | 1532 "id": "ListMonitoredResourceDescriptorsResponse", |
1565 "properties": { | 1533 "properties": { |
1566 "filter": { | 1534 "nextPageToken": { |
1567 "description": "The filter used to determine which monitored
resources belong to this group.", | 1535 "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.", |
1568 "type": "string" | 1536 "type": "string" |
1569 }, | 1537 }, |
1570 "name": { | 1538 "resourceDescriptors": { |
1571 "description": "Output only. The name of this group. The for
mat is \"projects/{project_id_or_number}/groups/{group_id}\". When creating a gr
oup, this field is ignored and a new name is created consisting of the project s
pecified in the call to CreateGroup and a unique {group_id} that is generated au
tomatically.", | 1539 "description": "The monitored resource descriptors that are
available to this project and that match filter, if present.", |
1572 "type": "string" | 1540 "items": { |
1573 }, | 1541 "$ref": "MonitoredResourceDescriptor" |
1574 "parentName": { | 1542 }, |
1575 "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 grou
ps with no parent, parentName is the empty string, \"\".", | 1543 "type": "array" |
1576 "type": "string" | |
1577 }, | |
1578 "displayName": { | |
1579 "description": "A user-assigned name for this group, used on
ly for display purposes.", | |
1580 "type": "string" | |
1581 }, | |
1582 "isCluster": { | |
1583 "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.", | |
1584 "type": "boolean" | |
1585 } | 1544 } |
1586 }, | 1545 }, |
1587 "type": "object" | 1546 "type": "object" |
1588 }, | 1547 }, |
1589 "BucketOptions": { | 1548 "TimeSeries": { |
1590 "description": "BucketOptions describes the bucket boundaries used t
o create a histogram for the distribution. The buckets can be in a linear sequen
ce, an exponential sequence, or each bucket can be specified explicitly. BucketO
ptions does not include the number of values in each bucket.A bucket has an incl
usive lower bound and exclusive upper bound for the values that are counted for
that bucket. The upper bound of a bucket must be strictly greater than the lower
bound. The sequence of N buckets for a distribution consists of an underflow bu
cket (number 0), zero or more finite buckets (number 1 through N - 2) and an ove
rflow bucket (number N - 1). The buckets are contiguous: the lower bound of buck
et i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span th
e whole range of finite values: lower bound of the underflow bucket is -infinity
and the upper bound of the overflow bucket is +infinity. The finite buckets are
so-called because both bounds are finite.", | 1549 "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.", |
1591 "id": "BucketOptions", | 1550 "id": "TimeSeries", |
1592 "properties": { | 1551 "properties": { |
1593 "exponentialBuckets": { | 1552 "valueType": { |
1594 "$ref": "Exponential", | 1553 "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.", |
1595 "description": "The exponential buckets." | 1554 "enum": [ |
| 1555 "VALUE_TYPE_UNSPECIFIED", |
| 1556 "BOOL", |
| 1557 "INT64", |
| 1558 "DOUBLE", |
| 1559 "STRING", |
| 1560 "DISTRIBUTION", |
| 1561 "MONEY" |
| 1562 ], |
| 1563 "enumDescriptions": [ |
| 1564 "Do not use this default value.", |
| 1565 "The value is a boolean. This value type can be used onl
y if the metric kind is GAUGE.", |
| 1566 "The value is a signed 64-bit integer.", |
| 1567 "The value is a double precision floating point number."
, |
| 1568 "The value is a text string. This value type can be used
only if the metric kind is GAUGE.", |
| 1569 "The value is a Distribution.", |
| 1570 "The value is money." |
| 1571 ], |
| 1572 "type": "string" |
1596 }, | 1573 }, |
1597 "linearBuckets": { | 1574 "resource": { |
1598 "$ref": "Linear", | 1575 "$ref": "MonitoredResource", |
1599 "description": "The linear bucket." | 1576 "description": "The associated monitored resource. Custom me
trics can use only certain monitored resource types in their time series data." |
1600 }, | 1577 }, |
1601 "explicitBuckets": { | 1578 "metricKind": { |
1602 "$ref": "Explicit", | 1579 "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.", |
1603 "description": "The explicit buckets." | 1580 "enum": [ |
| 1581 "METRIC_KIND_UNSPECIFIED", |
| 1582 "GAUGE", |
| 1583 "DELTA", |
| 1584 "CUMULATIVE" |
| 1585 ], |
| 1586 "enumDescriptions": [ |
| 1587 "Do not use this default value.", |
| 1588 "An instantaneous measurement of a value.", |
| 1589 "The change in a value during a time interval.", |
| 1590 "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." |
| 1591 ], |
| 1592 "type": "string" |
| 1593 }, |
| 1594 "points": { |
| 1595 "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.", |
| 1596 "items": { |
| 1597 "$ref": "Point" |
| 1598 }, |
| 1599 "type": "array" |
| 1600 }, |
| 1601 "metric": { |
| 1602 "$ref": "Metric", |
| 1603 "description": "The associated metric. A fully-specified met
ric used to identify the time series." |
1604 } | 1604 } |
1605 }, | 1605 }, |
1606 "type": "object" | 1606 "type": "object" |
1607 } | 1607 } |
1608 }, | 1608 }, |
1609 "servicePath": "", | 1609 "servicePath": "", |
1610 "title": "Stackdriver Monitoring API", | 1610 "title": "Stackdriver Monitoring API", |
1611 "version": "v3" | 1611 "version": "v3" |
1612 } | 1612 } |
OLD | NEW |