/
dextraceroutetest.go
656 lines (564 loc) · 23.9 KB
/
dextraceroutetest.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package zero_trust
import (
"context"
"fmt"
"net/http"
"net/url"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/apiquery"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/internal/shared"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// DEXTracerouteTestService contains methods and other services that help with
// interacting with the cloudflare API. Note, unlike clients, this service does not
// read variables from the environment automatically. You should not instantiate
// this service directly, and instead use the [NewDEXTracerouteTestService] method
// instead.
type DEXTracerouteTestService struct {
Options []option.RequestOption
}
// NewDEXTracerouteTestService generates a new service that applies the given
// options to each request. These options are applied after the parent client's
// options (if there is one), and before any request-specific options.
func NewDEXTracerouteTestService(opts ...option.RequestOption) (r *DEXTracerouteTestService) {
r = &DEXTracerouteTestService{}
r.Options = opts
return
}
// Get test details and aggregate performance metrics for an traceroute test for a
// given time period between 1 hour and 7 days.
func (r *DEXTracerouteTestService) Get(ctx context.Context, testID string, params DEXTracerouteTestGetParams, opts ...option.RequestOption) (res *Traceroute, err error) {
opts = append(r.Options[:], opts...)
var env DEXTracerouteTestGetResponseEnvelope
path := fmt.Sprintf("accounts/%s/dex/traceroute-tests/%s", params.AccountID, testID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Get a breakdown of metrics by hop for individual traceroute test runs
func (r *DEXTracerouteTestService) NetworkPath(ctx context.Context, testID string, params DEXTracerouteTestNetworkPathParams, opts ...option.RequestOption) (res *NetworkPathResponse, err error) {
opts = append(r.Options[:], opts...)
var env DEXTracerouteTestNetworkPathResponseEnvelope
path := fmt.Sprintf("accounts/%s/dex/traceroute-tests/%s/network-path", params.AccountID, testID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Get percentiles for a traceroute test for a given time period between 1 hour and
// 7 days.
func (r *DEXTracerouteTestService) Percentiles(ctx context.Context, testID string, params DEXTracerouteTestPercentilesParams, opts ...option.RequestOption) (res *DEXTracerouteTestPercentilesResponse, err error) {
opts = append(r.Options[:], opts...)
var env DEXTracerouteTestPercentilesResponseEnvelope
path := fmt.Sprintf("accounts/%s/dex/traceroute-tests/%s/percentiles", params.AccountID, testID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type Traceroute struct {
// The host of the Traceroute synthetic application test
Host string `json:"host,required"`
// The interval at which the Traceroute synthetic application test is set to run.
Interval string `json:"interval,required"`
Kind TracerouteKind `json:"kind,required"`
// The name of the Traceroute synthetic application test
Name string `json:"name,required"`
TargetPolicies []DeviceExperienceMonitor `json:"target_policies,nullable"`
Targeted bool `json:"targeted"`
TracerouteStats TracerouteTracerouteStats `json:"tracerouteStats,nullable"`
TracerouteStatsByColo []TracerouteTracerouteStatsByColo `json:"tracerouteStatsByColo"`
JSON tracerouteJSON `json:"-"`
}
// tracerouteJSON contains the JSON metadata for the struct [Traceroute]
type tracerouteJSON struct {
Host apijson.Field
Interval apijson.Field
Kind apijson.Field
Name apijson.Field
TargetPolicies apijson.Field
Targeted apijson.Field
TracerouteStats apijson.Field
TracerouteStatsByColo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *Traceroute) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteJSON) RawJSON() string {
return r.raw
}
type TracerouteKind string
const (
TracerouteKindTraceroute TracerouteKind = "traceroute"
)
func (r TracerouteKind) IsKnown() bool {
switch r {
case TracerouteKindTraceroute:
return true
}
return false
}
type TracerouteTracerouteStats struct {
AvailabilityPct TracerouteTracerouteStatsAvailabilityPct `json:"availabilityPct,required"`
HopsCount TestStatOverTime `json:"hopsCount,required"`
PacketLossPct TracerouteTracerouteStatsPacketLossPct `json:"packetLossPct,required"`
RoundTripTimeMs TestStatOverTime `json:"roundTripTimeMs,required"`
// Count of unique devices that have run this test in the given time period
UniqueDevicesTotal int64 `json:"uniqueDevicesTotal,required"`
JSON tracerouteTracerouteStatsJSON `json:"-"`
}
// tracerouteTracerouteStatsJSON contains the JSON metadata for the struct
// [TracerouteTracerouteStats]
type tracerouteTracerouteStatsJSON struct {
AvailabilityPct apijson.Field
HopsCount apijson.Field
PacketLossPct apijson.Field
RoundTripTimeMs apijson.Field
UniqueDevicesTotal apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStats) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsAvailabilityPct struct {
Slots []TracerouteTracerouteStatsAvailabilityPctSlot `json:"slots,required"`
// average observed in the time period
Avg float64 `json:"avg,nullable"`
// highest observed in the time period
Max float64 `json:"max,nullable"`
// lowest observed in the time period
Min float64 `json:"min,nullable"`
JSON tracerouteTracerouteStatsAvailabilityPctJSON `json:"-"`
}
// tracerouteTracerouteStatsAvailabilityPctJSON contains the JSON metadata for the
// struct [TracerouteTracerouteStatsAvailabilityPct]
type tracerouteTracerouteStatsAvailabilityPctJSON struct {
Slots apijson.Field
Avg apijson.Field
Max apijson.Field
Min apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsAvailabilityPct) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsAvailabilityPctJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsAvailabilityPctSlot struct {
Timestamp string `json:"timestamp,required"`
Value float64 `json:"value,required"`
JSON tracerouteTracerouteStatsAvailabilityPctSlotJSON `json:"-"`
}
// tracerouteTracerouteStatsAvailabilityPctSlotJSON contains the JSON metadata for
// the struct [TracerouteTracerouteStatsAvailabilityPctSlot]
type tracerouteTracerouteStatsAvailabilityPctSlotJSON struct {
Timestamp apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsAvailabilityPctSlot) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsAvailabilityPctSlotJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsPacketLossPct struct {
Slots []TracerouteTracerouteStatsPacketLossPctSlot `json:"slots,required"`
// average observed in the time period
Avg float64 `json:"avg,nullable"`
// highest observed in the time period
Max float64 `json:"max,nullable"`
// lowest observed in the time period
Min float64 `json:"min,nullable"`
JSON tracerouteTracerouteStatsPacketLossPctJSON `json:"-"`
}
// tracerouteTracerouteStatsPacketLossPctJSON contains the JSON metadata for the
// struct [TracerouteTracerouteStatsPacketLossPct]
type tracerouteTracerouteStatsPacketLossPctJSON struct {
Slots apijson.Field
Avg apijson.Field
Max apijson.Field
Min apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsPacketLossPct) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsPacketLossPctJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsPacketLossPctSlot struct {
Timestamp string `json:"timestamp,required"`
Value float64 `json:"value,required"`
JSON tracerouteTracerouteStatsPacketLossPctSlotJSON `json:"-"`
}
// tracerouteTracerouteStatsPacketLossPctSlotJSON contains the JSON metadata for
// the struct [TracerouteTracerouteStatsPacketLossPctSlot]
type tracerouteTracerouteStatsPacketLossPctSlotJSON struct {
Timestamp apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsPacketLossPctSlot) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsPacketLossPctSlotJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsByColo struct {
AvailabilityPct TracerouteTracerouteStatsByColoAvailabilityPct `json:"availabilityPct,required"`
Colo string `json:"colo,required"`
HopsCount TestStatOverTime `json:"hopsCount,required"`
PacketLossPct TracerouteTracerouteStatsByColoPacketLossPct `json:"packetLossPct,required"`
RoundTripTimeMs TestStatOverTime `json:"roundTripTimeMs,required"`
// Count of unique devices that have run this test in the given time period
UniqueDevicesTotal int64 `json:"uniqueDevicesTotal,required"`
JSON tracerouteTracerouteStatsByColoJSON `json:"-"`
}
// tracerouteTracerouteStatsByColoJSON contains the JSON metadata for the struct
// [TracerouteTracerouteStatsByColo]
type tracerouteTracerouteStatsByColoJSON struct {
AvailabilityPct apijson.Field
Colo apijson.Field
HopsCount apijson.Field
PacketLossPct apijson.Field
RoundTripTimeMs apijson.Field
UniqueDevicesTotal apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsByColo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsByColoJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsByColoAvailabilityPct struct {
Slots []TracerouteTracerouteStatsByColoAvailabilityPctSlot `json:"slots,required"`
// average observed in the time period
Avg float64 `json:"avg,nullable"`
// highest observed in the time period
Max float64 `json:"max,nullable"`
// lowest observed in the time period
Min float64 `json:"min,nullable"`
JSON tracerouteTracerouteStatsByColoAvailabilityPctJSON `json:"-"`
}
// tracerouteTracerouteStatsByColoAvailabilityPctJSON contains the JSON metadata
// for the struct [TracerouteTracerouteStatsByColoAvailabilityPct]
type tracerouteTracerouteStatsByColoAvailabilityPctJSON struct {
Slots apijson.Field
Avg apijson.Field
Max apijson.Field
Min apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsByColoAvailabilityPct) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsByColoAvailabilityPctJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsByColoAvailabilityPctSlot struct {
Timestamp string `json:"timestamp,required"`
Value float64 `json:"value,required"`
JSON tracerouteTracerouteStatsByColoAvailabilityPctSlotJSON `json:"-"`
}
// tracerouteTracerouteStatsByColoAvailabilityPctSlotJSON contains the JSON
// metadata for the struct [TracerouteTracerouteStatsByColoAvailabilityPctSlot]
type tracerouteTracerouteStatsByColoAvailabilityPctSlotJSON struct {
Timestamp apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsByColoAvailabilityPctSlot) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsByColoAvailabilityPctSlotJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsByColoPacketLossPct struct {
Slots []TracerouteTracerouteStatsByColoPacketLossPctSlot `json:"slots,required"`
// average observed in the time period
Avg float64 `json:"avg,nullable"`
// highest observed in the time period
Max float64 `json:"max,nullable"`
// lowest observed in the time period
Min float64 `json:"min,nullable"`
JSON tracerouteTracerouteStatsByColoPacketLossPctJSON `json:"-"`
}
// tracerouteTracerouteStatsByColoPacketLossPctJSON contains the JSON metadata for
// the struct [TracerouteTracerouteStatsByColoPacketLossPct]
type tracerouteTracerouteStatsByColoPacketLossPctJSON struct {
Slots apijson.Field
Avg apijson.Field
Max apijson.Field
Min apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsByColoPacketLossPct) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsByColoPacketLossPctJSON) RawJSON() string {
return r.raw
}
type TracerouteTracerouteStatsByColoPacketLossPctSlot struct {
Timestamp string `json:"timestamp,required"`
Value float64 `json:"value,required"`
JSON tracerouteTracerouteStatsByColoPacketLossPctSlotJSON `json:"-"`
}
// tracerouteTracerouteStatsByColoPacketLossPctSlotJSON contains the JSON metadata
// for the struct [TracerouteTracerouteStatsByColoPacketLossPctSlot]
type tracerouteTracerouteStatsByColoPacketLossPctSlotJSON struct {
Timestamp apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *TracerouteTracerouteStatsByColoPacketLossPctSlot) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r tracerouteTracerouteStatsByColoPacketLossPctSlotJSON) RawJSON() string {
return r.raw
}
type DEXTracerouteTestPercentilesResponse struct {
HopsCount Percentiles `json:"hopsCount"`
PacketLossPct Percentiles `json:"packetLossPct"`
RoundTripTimeMs Percentiles `json:"roundTripTimeMs"`
JSON dexTracerouteTestPercentilesResponseJSON `json:"-"`
}
// dexTracerouteTestPercentilesResponseJSON contains the JSON metadata for the
// struct [DEXTracerouteTestPercentilesResponse]
type dexTracerouteTestPercentilesResponseJSON struct {
HopsCount apijson.Field
PacketLossPct apijson.Field
RoundTripTimeMs apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DEXTracerouteTestPercentilesResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r dexTracerouteTestPercentilesResponseJSON) RawJSON() string {
return r.raw
}
type DEXTracerouteTestGetParams struct {
AccountID param.Field[string] `path:"account_id,required"`
// Time interval for aggregate time slots.
Interval param.Field[DEXTracerouteTestGetParamsInterval] `query:"interval,required"`
// End time for aggregate metrics in ISO ms
TimeEnd param.Field[string] `query:"timeEnd,required"`
// Start time for aggregate metrics in ISO ms
TimeStart param.Field[string] `query:"timeStart,required"`
// Optionally filter result stats to a Cloudflare colo. Cannot be used in
// combination with deviceId param.
Colo param.Field[string] `query:"colo"`
// Optionally filter result stats to a specific device(s). Cannot be used in
// combination with colo param.
DeviceID param.Field[[]string] `query:"deviceId"`
}
// URLQuery serializes [DEXTracerouteTestGetParams]'s query parameters as
// `url.Values`.
func (r DEXTracerouteTestGetParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Time interval for aggregate time slots.
type DEXTracerouteTestGetParamsInterval string
const (
DEXTracerouteTestGetParamsIntervalMinute DEXTracerouteTestGetParamsInterval = "minute"
DEXTracerouteTestGetParamsIntervalHour DEXTracerouteTestGetParamsInterval = "hour"
)
func (r DEXTracerouteTestGetParamsInterval) IsKnown() bool {
switch r {
case DEXTracerouteTestGetParamsIntervalMinute, DEXTracerouteTestGetParamsIntervalHour:
return true
}
return false
}
type DEXTracerouteTestGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success DEXTracerouteTestGetResponseEnvelopeSuccess `json:"success,required"`
Result Traceroute `json:"result"`
JSON dexTracerouteTestGetResponseEnvelopeJSON `json:"-"`
}
// dexTracerouteTestGetResponseEnvelopeJSON contains the JSON metadata for the
// struct [DEXTracerouteTestGetResponseEnvelope]
type dexTracerouteTestGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DEXTracerouteTestGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r dexTracerouteTestGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type DEXTracerouteTestGetResponseEnvelopeSuccess bool
const (
DEXTracerouteTestGetResponseEnvelopeSuccessTrue DEXTracerouteTestGetResponseEnvelopeSuccess = true
)
func (r DEXTracerouteTestGetResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case DEXTracerouteTestGetResponseEnvelopeSuccessTrue:
return true
}
return false
}
type DEXTracerouteTestNetworkPathParams struct {
AccountID param.Field[string] `path:"account_id,required"`
// Device to filter tracroute result runs to
DeviceID param.Field[string] `query:"deviceId,required"`
// Time interval for aggregate time slots.
Interval param.Field[DEXTracerouteTestNetworkPathParamsInterval] `query:"interval,required"`
// End time for aggregate metrics in ISO ms
TimeEnd param.Field[string] `query:"timeEnd,required"`
// Start time for aggregate metrics in ISO ms
TimeStart param.Field[string] `query:"timeStart,required"`
}
// URLQuery serializes [DEXTracerouteTestNetworkPathParams]'s query parameters as
// `url.Values`.
func (r DEXTracerouteTestNetworkPathParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Time interval for aggregate time slots.
type DEXTracerouteTestNetworkPathParamsInterval string
const (
DEXTracerouteTestNetworkPathParamsIntervalMinute DEXTracerouteTestNetworkPathParamsInterval = "minute"
DEXTracerouteTestNetworkPathParamsIntervalHour DEXTracerouteTestNetworkPathParamsInterval = "hour"
)
func (r DEXTracerouteTestNetworkPathParamsInterval) IsKnown() bool {
switch r {
case DEXTracerouteTestNetworkPathParamsIntervalMinute, DEXTracerouteTestNetworkPathParamsIntervalHour:
return true
}
return false
}
type DEXTracerouteTestNetworkPathResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success DEXTracerouteTestNetworkPathResponseEnvelopeSuccess `json:"success,required"`
Result NetworkPathResponse `json:"result"`
JSON dexTracerouteTestNetworkPathResponseEnvelopeJSON `json:"-"`
}
// dexTracerouteTestNetworkPathResponseEnvelopeJSON contains the JSON metadata for
// the struct [DEXTracerouteTestNetworkPathResponseEnvelope]
type dexTracerouteTestNetworkPathResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DEXTracerouteTestNetworkPathResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r dexTracerouteTestNetworkPathResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type DEXTracerouteTestNetworkPathResponseEnvelopeSuccess bool
const (
DEXTracerouteTestNetworkPathResponseEnvelopeSuccessTrue DEXTracerouteTestNetworkPathResponseEnvelopeSuccess = true
)
func (r DEXTracerouteTestNetworkPathResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case DEXTracerouteTestNetworkPathResponseEnvelopeSuccessTrue:
return true
}
return false
}
type DEXTracerouteTestPercentilesParams struct {
AccountID param.Field[string] `path:"account_id,required"`
// End time for aggregate metrics in ISO format
TimeEnd param.Field[string] `query:"timeEnd,required"`
// Start time for aggregate metrics in ISO format
TimeStart param.Field[string] `query:"timeStart,required"`
// Optionally filter result stats to a Cloudflare colo. Cannot be used in
// combination with deviceId param.
Colo param.Field[string] `query:"colo"`
// Optionally filter result stats to a specific device(s). Cannot be used in
// combination with colo param.
DeviceID param.Field[[]string] `query:"deviceId"`
}
// URLQuery serializes [DEXTracerouteTestPercentilesParams]'s query parameters as
// `url.Values`.
func (r DEXTracerouteTestPercentilesParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
type DEXTracerouteTestPercentilesResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success DEXTracerouteTestPercentilesResponseEnvelopeSuccess `json:"success,required"`
Result DEXTracerouteTestPercentilesResponse `json:"result"`
JSON dexTracerouteTestPercentilesResponseEnvelopeJSON `json:"-"`
}
// dexTracerouteTestPercentilesResponseEnvelopeJSON contains the JSON metadata for
// the struct [DEXTracerouteTestPercentilesResponseEnvelope]
type dexTracerouteTestPercentilesResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DEXTracerouteTestPercentilesResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r dexTracerouteTestPercentilesResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type DEXTracerouteTestPercentilesResponseEnvelopeSuccess bool
const (
DEXTracerouteTestPercentilesResponseEnvelopeSuccessTrue DEXTracerouteTestPercentilesResponseEnvelopeSuccess = true
)
func (r DEXTracerouteTestPercentilesResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case DEXTracerouteTestPercentilesResponseEnvelopeSuccessTrue:
return true
}
return false
}