@jacobhumston/roblox-openapi-ts 1.0.26 → 1.0.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/types.d.ts +622 -2
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -1,4 +1,442 @@
|
|
|
1
1
|
export interface paths {
|
|
2
|
+
"/analytics-query-api/v1/universes/{universeId}/dimension-values": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
get?: never;
|
|
10
|
+
put?: never;
|
|
11
|
+
/**
|
|
12
|
+
* Queries dimension values for a universe.
|
|
13
|
+
* @description See the <a href="https://create.roblox.com/docs/cloud/guides/analytics">Analytics guide</a> for more information.
|
|
14
|
+
*/
|
|
15
|
+
post: {
|
|
16
|
+
parameters: {
|
|
17
|
+
query?: never;
|
|
18
|
+
header?: never;
|
|
19
|
+
path: {
|
|
20
|
+
/** @description The universe ID to query dimension values for. */
|
|
21
|
+
universeId: number;
|
|
22
|
+
};
|
|
23
|
+
cookie?: never;
|
|
24
|
+
};
|
|
25
|
+
/** @description The dimension values request. */
|
|
26
|
+
requestBody: {
|
|
27
|
+
content: {
|
|
28
|
+
"application/json": components["schemas"]["DimensionValuesRequest"];
|
|
29
|
+
"text/json": components["schemas"]["DimensionValuesRequest"];
|
|
30
|
+
"application/*+json": components["schemas"]["DimensionValuesRequest"];
|
|
31
|
+
};
|
|
32
|
+
};
|
|
33
|
+
responses: {
|
|
34
|
+
/** @description OK */
|
|
35
|
+
200: {
|
|
36
|
+
headers: {
|
|
37
|
+
[name: string]: unknown;
|
|
38
|
+
};
|
|
39
|
+
content: {
|
|
40
|
+
"application/json": components["schemas"]["DimensionValuesOperationResult"];
|
|
41
|
+
};
|
|
42
|
+
};
|
|
43
|
+
/** @description Accepted */
|
|
44
|
+
202: {
|
|
45
|
+
headers: {
|
|
46
|
+
[name: string]: unknown;
|
|
47
|
+
};
|
|
48
|
+
content: {
|
|
49
|
+
"application/json": components["schemas"]["OperationPending"];
|
|
50
|
+
};
|
|
51
|
+
};
|
|
52
|
+
/** @description Bad Request */
|
|
53
|
+
400: {
|
|
54
|
+
headers: {
|
|
55
|
+
[name: string]: unknown;
|
|
56
|
+
};
|
|
57
|
+
content: {
|
|
58
|
+
"application/json": components["schemas"]["OperationError"];
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
/** @description Forbidden */
|
|
62
|
+
403: {
|
|
63
|
+
headers: {
|
|
64
|
+
[name: string]: unknown;
|
|
65
|
+
};
|
|
66
|
+
content: {
|
|
67
|
+
"application/json": components["schemas"]["OperationError"];
|
|
68
|
+
};
|
|
69
|
+
};
|
|
70
|
+
/** @description Too Many Requests */
|
|
71
|
+
429: {
|
|
72
|
+
headers: {
|
|
73
|
+
[name: string]: unknown;
|
|
74
|
+
};
|
|
75
|
+
content: {
|
|
76
|
+
"application/json": components["schemas"]["OperationError"];
|
|
77
|
+
};
|
|
78
|
+
};
|
|
79
|
+
/** @description Internal Server Error */
|
|
80
|
+
500: {
|
|
81
|
+
headers: {
|
|
82
|
+
[name: string]: unknown;
|
|
83
|
+
};
|
|
84
|
+
content: {
|
|
85
|
+
"application/json": components["schemas"]["OperationError"];
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
/** @description Service Unavailable */
|
|
89
|
+
503: {
|
|
90
|
+
headers: {
|
|
91
|
+
[name: string]: unknown;
|
|
92
|
+
};
|
|
93
|
+
content: {
|
|
94
|
+
"application/json": components["schemas"]["OperationError"];
|
|
95
|
+
};
|
|
96
|
+
};
|
|
97
|
+
/** @description Gateway Timeout */
|
|
98
|
+
504: {
|
|
99
|
+
headers: {
|
|
100
|
+
[name: string]: unknown;
|
|
101
|
+
};
|
|
102
|
+
content: {
|
|
103
|
+
"application/json": components["schemas"]["OperationError"];
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
delete?: never;
|
|
109
|
+
options?: never;
|
|
110
|
+
head?: never;
|
|
111
|
+
patch?: never;
|
|
112
|
+
trace?: never;
|
|
113
|
+
};
|
|
114
|
+
"/analytics-query-api/v1/universes/{universeId}/metrics": {
|
|
115
|
+
parameters: {
|
|
116
|
+
query?: never;
|
|
117
|
+
header?: never;
|
|
118
|
+
path?: never;
|
|
119
|
+
cookie?: never;
|
|
120
|
+
};
|
|
121
|
+
get?: never;
|
|
122
|
+
put?: never;
|
|
123
|
+
/**
|
|
124
|
+
* Queries time series metric data for a universe.
|
|
125
|
+
* @description See the <a href="https://create.roblox.com/docs/cloud/guides/analytics">Analytics guide</a> for more information.
|
|
126
|
+
*/
|
|
127
|
+
post: {
|
|
128
|
+
parameters: {
|
|
129
|
+
query?: never;
|
|
130
|
+
header?: never;
|
|
131
|
+
path: {
|
|
132
|
+
/** @description The universe ID to query metrics for. */
|
|
133
|
+
universeId: number;
|
|
134
|
+
};
|
|
135
|
+
cookie?: never;
|
|
136
|
+
};
|
|
137
|
+
/** @description The query request. */
|
|
138
|
+
requestBody: {
|
|
139
|
+
content: {
|
|
140
|
+
"application/json": components["schemas"]["QueryRequest"];
|
|
141
|
+
"text/json": components["schemas"]["QueryRequest"];
|
|
142
|
+
"application/*+json": components["schemas"]["QueryRequest"];
|
|
143
|
+
};
|
|
144
|
+
};
|
|
145
|
+
responses: {
|
|
146
|
+
/** @description OK */
|
|
147
|
+
200: {
|
|
148
|
+
headers: {
|
|
149
|
+
[name: string]: unknown;
|
|
150
|
+
};
|
|
151
|
+
content: {
|
|
152
|
+
"application/json": components["schemas"]["QueryOperationResult"];
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
/** @description Accepted */
|
|
156
|
+
202: {
|
|
157
|
+
headers: {
|
|
158
|
+
[name: string]: unknown;
|
|
159
|
+
};
|
|
160
|
+
content: {
|
|
161
|
+
"application/json": components["schemas"]["OperationPending"];
|
|
162
|
+
};
|
|
163
|
+
};
|
|
164
|
+
/** @description Bad Request */
|
|
165
|
+
400: {
|
|
166
|
+
headers: {
|
|
167
|
+
[name: string]: unknown;
|
|
168
|
+
};
|
|
169
|
+
content: {
|
|
170
|
+
"application/json": components["schemas"]["OperationError"];
|
|
171
|
+
};
|
|
172
|
+
};
|
|
173
|
+
/** @description Forbidden */
|
|
174
|
+
403: {
|
|
175
|
+
headers: {
|
|
176
|
+
[name: string]: unknown;
|
|
177
|
+
};
|
|
178
|
+
content: {
|
|
179
|
+
"application/json": components["schemas"]["OperationError"];
|
|
180
|
+
};
|
|
181
|
+
};
|
|
182
|
+
/** @description Too Many Requests */
|
|
183
|
+
429: {
|
|
184
|
+
headers: {
|
|
185
|
+
[name: string]: unknown;
|
|
186
|
+
};
|
|
187
|
+
content: {
|
|
188
|
+
"application/json": components["schemas"]["OperationError"];
|
|
189
|
+
};
|
|
190
|
+
};
|
|
191
|
+
/** @description Internal Server Error */
|
|
192
|
+
500: {
|
|
193
|
+
headers: {
|
|
194
|
+
[name: string]: unknown;
|
|
195
|
+
};
|
|
196
|
+
content: {
|
|
197
|
+
"application/json": components["schemas"]["OperationError"];
|
|
198
|
+
};
|
|
199
|
+
};
|
|
200
|
+
/** @description Service Unavailable */
|
|
201
|
+
503: {
|
|
202
|
+
headers: {
|
|
203
|
+
[name: string]: unknown;
|
|
204
|
+
};
|
|
205
|
+
content: {
|
|
206
|
+
"application/json": components["schemas"]["OperationError"];
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
/** @description Gateway Timeout */
|
|
210
|
+
504: {
|
|
211
|
+
headers: {
|
|
212
|
+
[name: string]: unknown;
|
|
213
|
+
};
|
|
214
|
+
content: {
|
|
215
|
+
"application/json": components["schemas"]["OperationError"];
|
|
216
|
+
};
|
|
217
|
+
};
|
|
218
|
+
};
|
|
219
|
+
};
|
|
220
|
+
delete?: never;
|
|
221
|
+
options?: never;
|
|
222
|
+
head?: never;
|
|
223
|
+
patch?: never;
|
|
224
|
+
trace?: never;
|
|
225
|
+
};
|
|
226
|
+
"/analytics-query-api/v1/universes/{universeId}/operations/dimension-values/{operationId}": {
|
|
227
|
+
parameters: {
|
|
228
|
+
query?: never;
|
|
229
|
+
header?: never;
|
|
230
|
+
path?: never;
|
|
231
|
+
cookie?: never;
|
|
232
|
+
};
|
|
233
|
+
/**
|
|
234
|
+
* Retrieves the result of a long-running dimension values operation.
|
|
235
|
+
* @description See the <a href="https://create.roblox.com/docs/cloud/guides/analytics">Analytics guide</a> for more information.
|
|
236
|
+
*/
|
|
237
|
+
get: {
|
|
238
|
+
parameters: {
|
|
239
|
+
query?: never;
|
|
240
|
+
header?: never;
|
|
241
|
+
path: {
|
|
242
|
+
/** @description The universe ID the operation belongs to. */
|
|
243
|
+
universeId: number;
|
|
244
|
+
/** @description The operation id returned from a prior dimension values request. */
|
|
245
|
+
operationId: string;
|
|
246
|
+
};
|
|
247
|
+
cookie?: never;
|
|
248
|
+
};
|
|
249
|
+
requestBody?: never;
|
|
250
|
+
responses: {
|
|
251
|
+
/** @description OK */
|
|
252
|
+
200: {
|
|
253
|
+
headers: {
|
|
254
|
+
[name: string]: unknown;
|
|
255
|
+
};
|
|
256
|
+
content: {
|
|
257
|
+
"application/json": components["schemas"]["DimensionValuesOperationResult"];
|
|
258
|
+
};
|
|
259
|
+
};
|
|
260
|
+
/** @description Accepted */
|
|
261
|
+
202: {
|
|
262
|
+
headers: {
|
|
263
|
+
[name: string]: unknown;
|
|
264
|
+
};
|
|
265
|
+
content: {
|
|
266
|
+
"application/json": components["schemas"]["OperationPending"];
|
|
267
|
+
};
|
|
268
|
+
};
|
|
269
|
+
/** @description Bad Request */
|
|
270
|
+
400: {
|
|
271
|
+
headers: {
|
|
272
|
+
[name: string]: unknown;
|
|
273
|
+
};
|
|
274
|
+
content: {
|
|
275
|
+
"application/json": components["schemas"]["OperationError"];
|
|
276
|
+
};
|
|
277
|
+
};
|
|
278
|
+
/** @description Not Found */
|
|
279
|
+
404: {
|
|
280
|
+
headers: {
|
|
281
|
+
[name: string]: unknown;
|
|
282
|
+
};
|
|
283
|
+
content: {
|
|
284
|
+
"application/json": components["schemas"]["OperationError"];
|
|
285
|
+
};
|
|
286
|
+
};
|
|
287
|
+
/** @description Too Many Requests */
|
|
288
|
+
429: {
|
|
289
|
+
headers: {
|
|
290
|
+
[name: string]: unknown;
|
|
291
|
+
};
|
|
292
|
+
content: {
|
|
293
|
+
"application/json": components["schemas"]["OperationError"];
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
/** @description Internal Server Error */
|
|
297
|
+
500: {
|
|
298
|
+
headers: {
|
|
299
|
+
[name: string]: unknown;
|
|
300
|
+
};
|
|
301
|
+
content: {
|
|
302
|
+
"application/json": components["schemas"]["OperationError"];
|
|
303
|
+
};
|
|
304
|
+
};
|
|
305
|
+
/** @description Service Unavailable */
|
|
306
|
+
503: {
|
|
307
|
+
headers: {
|
|
308
|
+
[name: string]: unknown;
|
|
309
|
+
};
|
|
310
|
+
content: {
|
|
311
|
+
"application/json": components["schemas"]["OperationError"];
|
|
312
|
+
};
|
|
313
|
+
};
|
|
314
|
+
/** @description Gateway Timeout */
|
|
315
|
+
504: {
|
|
316
|
+
headers: {
|
|
317
|
+
[name: string]: unknown;
|
|
318
|
+
};
|
|
319
|
+
content: {
|
|
320
|
+
"application/json": components["schemas"]["OperationError"];
|
|
321
|
+
};
|
|
322
|
+
};
|
|
323
|
+
};
|
|
324
|
+
};
|
|
325
|
+
put?: never;
|
|
326
|
+
post?: never;
|
|
327
|
+
delete?: never;
|
|
328
|
+
options?: never;
|
|
329
|
+
head?: never;
|
|
330
|
+
patch?: never;
|
|
331
|
+
trace?: never;
|
|
332
|
+
};
|
|
333
|
+
"/analytics-query-api/v1/universes/{universeId}/operations/metrics/{operationId}": {
|
|
334
|
+
parameters: {
|
|
335
|
+
query?: never;
|
|
336
|
+
header?: never;
|
|
337
|
+
path?: never;
|
|
338
|
+
cookie?: never;
|
|
339
|
+
};
|
|
340
|
+
/**
|
|
341
|
+
* Retrieves the result of a long-running metrics query operation.
|
|
342
|
+
* @description See the <a href="https://create.roblox.com/docs/cloud/guides/analytics">Analytics guide</a> for more information.
|
|
343
|
+
*/
|
|
344
|
+
get: {
|
|
345
|
+
parameters: {
|
|
346
|
+
query?: never;
|
|
347
|
+
header?: never;
|
|
348
|
+
path: {
|
|
349
|
+
/** @description The universe ID the operation belongs to. */
|
|
350
|
+
universeId: number;
|
|
351
|
+
/** @description The operation id returned from a prior query request. */
|
|
352
|
+
operationId: string;
|
|
353
|
+
};
|
|
354
|
+
cookie?: never;
|
|
355
|
+
};
|
|
356
|
+
requestBody?: never;
|
|
357
|
+
responses: {
|
|
358
|
+
/** @description OK */
|
|
359
|
+
200: {
|
|
360
|
+
headers: {
|
|
361
|
+
[name: string]: unknown;
|
|
362
|
+
};
|
|
363
|
+
content: {
|
|
364
|
+
"application/json": components["schemas"]["QueryOperationResult"];
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
/** @description Accepted */
|
|
368
|
+
202: {
|
|
369
|
+
headers: {
|
|
370
|
+
[name: string]: unknown;
|
|
371
|
+
};
|
|
372
|
+
content: {
|
|
373
|
+
"application/json": components["schemas"]["OperationPending"];
|
|
374
|
+
};
|
|
375
|
+
};
|
|
376
|
+
/** @description Bad Request */
|
|
377
|
+
400: {
|
|
378
|
+
headers: {
|
|
379
|
+
[name: string]: unknown;
|
|
380
|
+
};
|
|
381
|
+
content: {
|
|
382
|
+
"application/json": components["schemas"]["OperationError"];
|
|
383
|
+
};
|
|
384
|
+
};
|
|
385
|
+
/** @description Not Found */
|
|
386
|
+
404: {
|
|
387
|
+
headers: {
|
|
388
|
+
[name: string]: unknown;
|
|
389
|
+
};
|
|
390
|
+
content: {
|
|
391
|
+
"application/json": components["schemas"]["OperationError"];
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
/** @description Too Many Requests */
|
|
395
|
+
429: {
|
|
396
|
+
headers: {
|
|
397
|
+
[name: string]: unknown;
|
|
398
|
+
};
|
|
399
|
+
content: {
|
|
400
|
+
"application/json": components["schemas"]["OperationError"];
|
|
401
|
+
};
|
|
402
|
+
};
|
|
403
|
+
/** @description Internal Server Error */
|
|
404
|
+
500: {
|
|
405
|
+
headers: {
|
|
406
|
+
[name: string]: unknown;
|
|
407
|
+
};
|
|
408
|
+
content: {
|
|
409
|
+
"application/json": components["schemas"]["OperationError"];
|
|
410
|
+
};
|
|
411
|
+
};
|
|
412
|
+
/** @description Service Unavailable */
|
|
413
|
+
503: {
|
|
414
|
+
headers: {
|
|
415
|
+
[name: string]: unknown;
|
|
416
|
+
};
|
|
417
|
+
content: {
|
|
418
|
+
"application/json": components["schemas"]["OperationError"];
|
|
419
|
+
};
|
|
420
|
+
};
|
|
421
|
+
/** @description Gateway Timeout */
|
|
422
|
+
504: {
|
|
423
|
+
headers: {
|
|
424
|
+
[name: string]: unknown;
|
|
425
|
+
};
|
|
426
|
+
content: {
|
|
427
|
+
"application/json": components["schemas"]["OperationError"];
|
|
428
|
+
};
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
put?: never;
|
|
433
|
+
post?: never;
|
|
434
|
+
delete?: never;
|
|
435
|
+
options?: never;
|
|
436
|
+
head?: never;
|
|
437
|
+
patch?: never;
|
|
438
|
+
trace?: never;
|
|
439
|
+
};
|
|
2
440
|
"/asset-delivery-api/v1/assetId/{assetId}": {
|
|
3
441
|
parameters: {
|
|
4
442
|
query?: never;
|
|
@@ -1595,7 +2033,7 @@ export interface paths {
|
|
|
1595
2033
|
};
|
|
1596
2034
|
/**
|
|
1597
2035
|
* Get Memory Store Flush Operation
|
|
1598
|
-
* @description Retrieves the status of the operation to [flush the memory stores of a universe](https://create.roblox.com/docs/cloud/reference/features/
|
|
2036
|
+
* @description Retrieves the status of the operation to [flush the memory stores of a universe](https://create.roblox.com/docs/cloud/reference/features/storage#Cloud_FlushMemoryStore).
|
|
1599
2037
|
*/
|
|
1600
2038
|
get: operations["Cloud_GetMemoryStoreFlushOperation"];
|
|
1601
2039
|
put?: never;
|
|
@@ -1898,7 +2336,7 @@ export interface paths {
|
|
|
1898
2336
|
};
|
|
1899
2337
|
/**
|
|
1900
2338
|
* Get Update Instance Operation
|
|
1901
|
-
* @description Retrieves the status of the operation to [update an instance](https://create.roblox.com/docs/cloud/reference/features/
|
|
2339
|
+
* @description Retrieves the status of the operation to [update an instance](https://create.roblox.com/docs/cloud/reference/features/universes#Cloud_UpdateInstance).
|
|
1902
2340
|
*/
|
|
1903
2341
|
get: operations["Cloud_GetUpdateInstanceOperation"];
|
|
1904
2342
|
put?: never;
|
|
@@ -42298,6 +42736,15 @@ export interface components {
|
|
|
42298
42736
|
/** @description The list of grants that had errors. */
|
|
42299
42737
|
errors?: components["schemas"]["GrantPermissionError"][] | null;
|
|
42300
42738
|
};
|
|
42739
|
+
/** @description A breakdown dimension value in a query result. */
|
|
42740
|
+
BreakdownValue: {
|
|
42741
|
+
/** @description The dimension name. */
|
|
42742
|
+
dimension: string;
|
|
42743
|
+
/** @description The dimension value. */
|
|
42744
|
+
value: string;
|
|
42745
|
+
/** @description A human-readable display value when the dimension is a unique ID. */
|
|
42746
|
+
displayValue?: string | null;
|
|
42747
|
+
};
|
|
42301
42748
|
/** @description Request model for bulk deleting saves */
|
|
42302
42749
|
BulkDeleteSavesRequest: {
|
|
42303
42750
|
/** @description A list of saves being deleted */
|
|
@@ -42805,6 +43252,27 @@ export interface components {
|
|
|
42805
43252
|
* @enum {string}
|
|
42806
43253
|
*/
|
|
42807
43254
|
CustomSignalType: "Invalid" | "PlayerCategorical" | "ServerCategorical" | "ServerNumerical" | "PlayerNumerical";
|
|
43255
|
+
/** @description A single data point in a metric query result. */
|
|
43256
|
+
DataPoint: {
|
|
43257
|
+
/**
|
|
43258
|
+
* Format: date-time
|
|
43259
|
+
* @description The timestamp of the data point in UTC.
|
|
43260
|
+
*/
|
|
43261
|
+
time: string;
|
|
43262
|
+
/**
|
|
43263
|
+
* Format: double
|
|
43264
|
+
* @description The numeric value of the data point.
|
|
43265
|
+
*/
|
|
43266
|
+
value: number;
|
|
43267
|
+
/** @description String values associated with the data point, when applicable. */
|
|
43268
|
+
stringValues?: string[] | null;
|
|
43269
|
+
status?: components["schemas"]["DataStatus"];
|
|
43270
|
+
};
|
|
43271
|
+
/**
|
|
43272
|
+
* @description The status of a data point in a query result.
|
|
43273
|
+
* @enum {string}
|
|
43274
|
+
*/
|
|
43275
|
+
DataStatus: "Valid" | "Projected" | "NotStatisticallySignificant";
|
|
42808
43276
|
/** @description Represents a data store. */
|
|
42809
43277
|
DataStore: {
|
|
42810
43278
|
/**
|
|
@@ -43058,6 +43526,59 @@ export interface components {
|
|
|
43058
43526
|
/** @description Whether managed pricing is enabled for the developer product. */
|
|
43059
43527
|
isManagedPricingEnabled: boolean;
|
|
43060
43528
|
};
|
|
43529
|
+
/** @description A single dimension value returned by a dimension values query. */
|
|
43530
|
+
DimensionValue: {
|
|
43531
|
+
/** @description The dimension value. */
|
|
43532
|
+
value: string;
|
|
43533
|
+
/** @description A human-readable display value when the dimension is a unique ID. */
|
|
43534
|
+
displayValue?: string | null;
|
|
43535
|
+
};
|
|
43536
|
+
/** @description The values for a single dimension returned by a dimension values query. */
|
|
43537
|
+
DimensionValues: {
|
|
43538
|
+
/** @description The dimension name. */
|
|
43539
|
+
dimension: string;
|
|
43540
|
+
/** @description The values for the dimension. */
|
|
43541
|
+
values?: components["schemas"]["DimensionValue"][];
|
|
43542
|
+
};
|
|
43543
|
+
/** @description A completed long-running dimension values operation with results. */
|
|
43544
|
+
DimensionValuesOperationResult: {
|
|
43545
|
+
/** @description The server-assigned resource path. */
|
|
43546
|
+
path?: string | null;
|
|
43547
|
+
/** @description If false, the operation is still in progress. If true, the operation is completed. */
|
|
43548
|
+
done?: boolean;
|
|
43549
|
+
response?: components["schemas"]["DimensionValuesResponse"];
|
|
43550
|
+
metadata?: components["schemas"]["OperationMetadata"];
|
|
43551
|
+
};
|
|
43552
|
+
/** @description A request to query dimension values. */
|
|
43553
|
+
DimensionValuesRequest: {
|
|
43554
|
+
/** @description The metric that provides context for resolving dimension namespaces. */
|
|
43555
|
+
metric: string;
|
|
43556
|
+
/** @description The dimensions to retrieve values for. Each entry is a single dimension name. */
|
|
43557
|
+
dimensions?: string[];
|
|
43558
|
+
/**
|
|
43559
|
+
* Format: date-time
|
|
43560
|
+
* @description The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
|
|
43561
|
+
*/
|
|
43562
|
+
startTime: string;
|
|
43563
|
+
/**
|
|
43564
|
+
* Format: date-time
|
|
43565
|
+
* @description The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
|
|
43566
|
+
*/
|
|
43567
|
+
endTime: string;
|
|
43568
|
+
/** @description Filters to apply to the query. */
|
|
43569
|
+
filter?: components["schemas"]["QueryFilter"][];
|
|
43570
|
+
granularity?: components["schemas"]["MetricGranularity"];
|
|
43571
|
+
/**
|
|
43572
|
+
* Format: int32
|
|
43573
|
+
* @description The maximum number of values to return per dimension.
|
|
43574
|
+
*/
|
|
43575
|
+
limit?: number;
|
|
43576
|
+
};
|
|
43577
|
+
/** @description The response for a dimension values query. */
|
|
43578
|
+
DimensionValuesResponse: {
|
|
43579
|
+
/** @description The dimension values returned by the query. */
|
|
43580
|
+
values?: components["schemas"]["DimensionValues"][];
|
|
43581
|
+
};
|
|
43061
43582
|
/** @description Discards read items from the front of the queue. */
|
|
43062
43583
|
DiscardMemoryStoreQueueItemsRequest: {
|
|
43063
43584
|
/**
|
|
@@ -43143,6 +43664,11 @@ export interface components {
|
|
|
43143
43664
|
/** @description The list of available values for the filter. */
|
|
43144
43665
|
values?: unknown[] | null;
|
|
43145
43666
|
};
|
|
43667
|
+
/**
|
|
43668
|
+
* @description The operation to apply to a query filter.
|
|
43669
|
+
* @enum {string}
|
|
43670
|
+
*/
|
|
43671
|
+
FilterOperation: "In" | "NotIn" | "GreaterThan" | "GreaterThanOrEqual" | "LessThan" | "LessThanOrEqual" | "Match";
|
|
43146
43672
|
/** @description Response model for filter options endpoint. */
|
|
43147
43673
|
FilterOptionsResponse: {
|
|
43148
43674
|
/** @description A dictionary of filter field names to their metadata and available values. */
|
|
@@ -45275,6 +45801,18 @@ export interface components {
|
|
|
45275
45801
|
*/
|
|
45276
45802
|
readonly count?: number;
|
|
45277
45803
|
};
|
|
45804
|
+
/**
|
|
45805
|
+
* @description The time granularity of metric data points in a query.
|
|
45806
|
+
* @enum {string}
|
|
45807
|
+
*/
|
|
45808
|
+
MetricGranularity: "OneMinute" | "HalfHour" | "OneHour" | "OneDay" | "OneWeek" | "OneMonth" | "None";
|
|
45809
|
+
/** @description A metric value for a single breakdown series. */
|
|
45810
|
+
MetricValue: {
|
|
45811
|
+
/** @description The breakdown values for this series. */
|
|
45812
|
+
breakdowns?: components["schemas"]["BreakdownValue"][];
|
|
45813
|
+
/** @description The data points for this series. */
|
|
45814
|
+
dataPoints?: components["schemas"]["DataPoint"][];
|
|
45815
|
+
};
|
|
45278
45816
|
/** @description Mock server signal values. */
|
|
45279
45817
|
MockServerSignalValues: {
|
|
45280
45818
|
/**
|
|
@@ -45570,12 +46108,37 @@ export interface components {
|
|
|
45570
46108
|
*/
|
|
45571
46109
|
response?: components["schemas"]["GoogleProtobufAny"];
|
|
45572
46110
|
};
|
|
46111
|
+
/** @description A completed long-running operation that failed with an error. */
|
|
46112
|
+
OperationError: {
|
|
46113
|
+
/** @description The server-assigned resource path. */
|
|
46114
|
+
path?: string | null;
|
|
46115
|
+
/** @description If false, the operation is still in progress. If true, the operation is completed. */
|
|
46116
|
+
done?: boolean;
|
|
46117
|
+
error?: components["schemas"]["QueryError"];
|
|
46118
|
+
metadata?: components["schemas"]["OperationMetadata"];
|
|
46119
|
+
};
|
|
45573
46120
|
OperationErrorResponse: {
|
|
45574
46121
|
/** Format: int32 */
|
|
45575
46122
|
readonly code?: number;
|
|
45576
46123
|
readonly error?: string | null;
|
|
45577
46124
|
message?: string | null;
|
|
45578
46125
|
};
|
|
46126
|
+
/** @description The metadata associated with a long-running operation. */
|
|
46127
|
+
OperationMetadata: {
|
|
46128
|
+
/**
|
|
46129
|
+
* Format: date-time
|
|
46130
|
+
* @description The time the operation was created.
|
|
46131
|
+
*/
|
|
46132
|
+
createdTime?: string | null;
|
|
46133
|
+
};
|
|
46134
|
+
/** @description A long-running operation that is still in progress. */
|
|
46135
|
+
OperationPending: {
|
|
46136
|
+
/** @description The server-assigned resource path. */
|
|
46137
|
+
path?: string | null;
|
|
46138
|
+
/** @description If false, the operation is still in progress. If true, the operation is completed. */
|
|
46139
|
+
done?: boolean;
|
|
46140
|
+
metadata?: components["schemas"]["OperationMetadata"];
|
|
46141
|
+
};
|
|
45579
46142
|
/** @description A key-value entry in an ordered data store. */
|
|
45580
46143
|
OrderedDataStoreEntry: {
|
|
45581
46144
|
/**
|
|
@@ -46077,6 +46640,16 @@ export interface components {
|
|
|
46077
46640
|
/** @description The suggested spelling correction for the original search query. */
|
|
46078
46641
|
suggestedQuery?: string | null;
|
|
46079
46642
|
} | null;
|
|
46643
|
+
/** @description The error returned from a query request. */
|
|
46644
|
+
QueryError: {
|
|
46645
|
+
/**
|
|
46646
|
+
* Format: int32
|
|
46647
|
+
* @description The error code.
|
|
46648
|
+
*/
|
|
46649
|
+
code?: number;
|
|
46650
|
+
/** @description The message associated with the query error. */
|
|
46651
|
+
message: string;
|
|
46652
|
+
};
|
|
46080
46653
|
/** @description The facets of a query. */
|
|
46081
46654
|
QueryFacets: {
|
|
46082
46655
|
/** @description Facets that are already applied to the search. */
|
|
@@ -46084,6 +46657,53 @@ export interface components {
|
|
|
46084
46657
|
/** @description The unused and still available facets. */
|
|
46085
46658
|
availableFacets?: string[] | null;
|
|
46086
46659
|
} | null;
|
|
46660
|
+
/** @description A filter applied to a query dimension. */
|
|
46661
|
+
QueryFilter: {
|
|
46662
|
+
/** @description The dimension name to filter on. */
|
|
46663
|
+
dimension: string;
|
|
46664
|
+
/** @description The values to filter by. */
|
|
46665
|
+
values?: string[];
|
|
46666
|
+
operation: components["schemas"]["FilterOperation"];
|
|
46667
|
+
};
|
|
46668
|
+
/** @description A completed long-running query operation with results. */
|
|
46669
|
+
QueryOperationResult: {
|
|
46670
|
+
/** @description The server-assigned resource path. */
|
|
46671
|
+
path?: string | null;
|
|
46672
|
+
/** @description If false, the operation is still in progress. If true, the operation is completed. */
|
|
46673
|
+
done?: boolean;
|
|
46674
|
+
response?: components["schemas"]["QueryResponse"];
|
|
46675
|
+
metadata?: components["schemas"]["OperationMetadata"];
|
|
46676
|
+
};
|
|
46677
|
+
/** @description A request to query time series metric data. */
|
|
46678
|
+
QueryRequest: {
|
|
46679
|
+
/** @description The metric to query. */
|
|
46680
|
+
metric: string;
|
|
46681
|
+
granularity: components["schemas"]["MetricGranularity"];
|
|
46682
|
+
/**
|
|
46683
|
+
* Format: date-time
|
|
46684
|
+
* @description The inclusive start of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
|
|
46685
|
+
*/
|
|
46686
|
+
startTime: string;
|
|
46687
|
+
/**
|
|
46688
|
+
* Format: date-time
|
|
46689
|
+
* @description The exclusive end of the query time range. Any UTC offset is accepted; results are always bucketed in UTC.
|
|
46690
|
+
*/
|
|
46691
|
+
endTime: string;
|
|
46692
|
+
/** @description The dimensions to group results by. Each entry is a single dimension name. */
|
|
46693
|
+
breakdown?: string[];
|
|
46694
|
+
/** @description Filters to apply to the query. */
|
|
46695
|
+
filter?: components["schemas"]["QueryFilter"][];
|
|
46696
|
+
/**
|
|
46697
|
+
* Format: int32
|
|
46698
|
+
* @description The maximum number of breakdown series to return.
|
|
46699
|
+
*/
|
|
46700
|
+
limit?: number;
|
|
46701
|
+
};
|
|
46702
|
+
/** @description The response for a metric query. */
|
|
46703
|
+
QueryResponse: {
|
|
46704
|
+
/** @description The metric values returned by the query. */
|
|
46705
|
+
values?: components["schemas"]["MetricValue"][];
|
|
46706
|
+
};
|
|
46087
46707
|
/** @description Returns the specified number of items at the front of the queue. */
|
|
46088
46708
|
ReadMemoryStoreQueueItemsResponse: {
|
|
46089
46709
|
/**
|