-
Notifications
You must be signed in to change notification settings - Fork 541
/
qualityspeed.go
436 lines (376 loc) · 16.7 KB
/
qualityspeed.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package radar
import (
"context"
"net/http"
"net/url"
"time"
"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/option"
)
// QualitySpeedService 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 [NewQualitySpeedService] method
// instead.
type QualitySpeedService struct {
Options []option.RequestOption
Top *QualitySpeedTopService
}
// NewQualitySpeedService 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 NewQualitySpeedService(opts ...option.RequestOption) (r *QualitySpeedService) {
r = &QualitySpeedService{}
r.Options = opts
r.Top = NewQualitySpeedTopService(opts...)
return
}
// Get an histogram from the previous 90 days of Cloudflare Speed Test data, split
// into fixed bandwidth (Mbps), latency (ms) or jitter (ms) buckets.
func (r *QualitySpeedService) Histogram(ctx context.Context, query QualitySpeedHistogramParams, opts ...option.RequestOption) (res *QualitySpeedHistogramResponse, err error) {
opts = append(r.Options[:], opts...)
var env QualitySpeedHistogramResponseEnvelope
path := "radar/quality/speed/histogram"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Get a summary of bandwidth, latency, jitter and packet loss, from the previous
// 90 days of Cloudflare Speed Test data.
func (r *QualitySpeedService) Summary(ctx context.Context, query QualitySpeedSummaryParams, opts ...option.RequestOption) (res *QualitySpeedSummaryResponse, err error) {
opts = append(r.Options[:], opts...)
var env QualitySpeedSummaryResponseEnvelope
path := "radar/quality/speed/summary"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type QualitySpeedHistogramResponse struct {
Histogram0 QualitySpeedHistogramResponseHistogram0 `json:"histogram_0,required"`
Meta interface{} `json:"meta,required"`
JSON qualitySpeedHistogramResponseJSON `json:"-"`
}
// qualitySpeedHistogramResponseJSON contains the JSON metadata for the struct
// [QualitySpeedHistogramResponse]
type qualitySpeedHistogramResponseJSON struct {
Histogram0 apijson.Field
Meta apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedHistogramResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedHistogramResponseJSON) RawJSON() string {
return r.raw
}
type QualitySpeedHistogramResponseHistogram0 struct {
BandwidthDownload []string `json:"bandwidthDownload,required"`
BandwidthUpload []string `json:"bandwidthUpload,required"`
BucketMin []string `json:"bucketMin,required"`
JSON qualitySpeedHistogramResponseHistogram0JSON `json:"-"`
}
// qualitySpeedHistogramResponseHistogram0JSON contains the JSON metadata for the
// struct [QualitySpeedHistogramResponseHistogram0]
type qualitySpeedHistogramResponseHistogram0JSON struct {
BandwidthDownload apijson.Field
BandwidthUpload apijson.Field
BucketMin apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedHistogramResponseHistogram0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedHistogramResponseHistogram0JSON) RawJSON() string {
return r.raw
}
type QualitySpeedSummaryResponse struct {
Meta QualitySpeedSummaryResponseMeta `json:"meta,required"`
Summary0 QualitySpeedSummaryResponseSummary0 `json:"summary_0,required"`
JSON qualitySpeedSummaryResponseJSON `json:"-"`
}
// qualitySpeedSummaryResponseJSON contains the JSON metadata for the struct
// [QualitySpeedSummaryResponse]
type qualitySpeedSummaryResponseJSON struct {
Meta apijson.Field
Summary0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedSummaryResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedSummaryResponseJSON) RawJSON() string {
return r.raw
}
type QualitySpeedSummaryResponseMeta struct {
DateRange []QualitySpeedSummaryResponseMetaDateRange `json:"dateRange,required"`
LastUpdated string `json:"lastUpdated,required"`
Normalization string `json:"normalization,required"`
ConfidenceInfo QualitySpeedSummaryResponseMetaConfidenceInfo `json:"confidenceInfo"`
JSON qualitySpeedSummaryResponseMetaJSON `json:"-"`
}
// qualitySpeedSummaryResponseMetaJSON contains the JSON metadata for the struct
// [QualitySpeedSummaryResponseMeta]
type qualitySpeedSummaryResponseMetaJSON struct {
DateRange apijson.Field
LastUpdated apijson.Field
Normalization apijson.Field
ConfidenceInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedSummaryResponseMeta) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedSummaryResponseMetaJSON) RawJSON() string {
return r.raw
}
type QualitySpeedSummaryResponseMetaDateRange struct {
// Adjusted end of date range.
EndTime time.Time `json:"endTime,required" format:"date-time"`
// Adjusted start of date range.
StartTime time.Time `json:"startTime,required" format:"date-time"`
JSON qualitySpeedSummaryResponseMetaDateRangeJSON `json:"-"`
}
// qualitySpeedSummaryResponseMetaDateRangeJSON contains the JSON metadata for the
// struct [QualitySpeedSummaryResponseMetaDateRange]
type qualitySpeedSummaryResponseMetaDateRangeJSON struct {
EndTime apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedSummaryResponseMetaDateRange) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedSummaryResponseMetaDateRangeJSON) RawJSON() string {
return r.raw
}
type QualitySpeedSummaryResponseMetaConfidenceInfo struct {
Annotations []QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation `json:"annotations"`
Level int64 `json:"level"`
JSON qualitySpeedSummaryResponseMetaConfidenceInfoJSON `json:"-"`
}
// qualitySpeedSummaryResponseMetaConfidenceInfoJSON contains the JSON metadata for
// the struct [QualitySpeedSummaryResponseMetaConfidenceInfo]
type qualitySpeedSummaryResponseMetaConfidenceInfoJSON struct {
Annotations apijson.Field
Level apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedSummaryResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedSummaryResponseMetaConfidenceInfoJSON) RawJSON() string {
return r.raw
}
type QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EventType string `json:"eventType,required"`
IsInstantaneous interface{} `json:"isInstantaneous,required"`
EndTime time.Time `json:"endTime" format:"date-time"`
LinkedURL string `json:"linkedUrl"`
StartTime time.Time `json:"startTime" format:"date-time"`
JSON qualitySpeedSummaryResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
// qualitySpeedSummaryResponseMetaConfidenceInfoAnnotationJSON contains the JSON
// metadata for the struct
// [QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation]
type qualitySpeedSummaryResponseMetaConfidenceInfoAnnotationJSON struct {
DataSource apijson.Field
Description apijson.Field
EventType apijson.Field
IsInstantaneous apijson.Field
EndTime apijson.Field
LinkedURL apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedSummaryResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedSummaryResponseMetaConfidenceInfoAnnotationJSON) RawJSON() string {
return r.raw
}
type QualitySpeedSummaryResponseSummary0 struct {
BandwidthDownload string `json:"bandwidthDownload,required"`
BandwidthUpload string `json:"bandwidthUpload,required"`
JitterIdle string `json:"jitterIdle,required"`
JitterLoaded string `json:"jitterLoaded,required"`
LatencyIdle string `json:"latencyIdle,required"`
LatencyLoaded string `json:"latencyLoaded,required"`
PacketLoss string `json:"packetLoss,required"`
JSON qualitySpeedSummaryResponseSummary0JSON `json:"-"`
}
// qualitySpeedSummaryResponseSummary0JSON contains the JSON metadata for the
// struct [QualitySpeedSummaryResponseSummary0]
type qualitySpeedSummaryResponseSummary0JSON struct {
BandwidthDownload apijson.Field
BandwidthUpload apijson.Field
JitterIdle apijson.Field
JitterLoaded apijson.Field
LatencyIdle apijson.Field
LatencyLoaded apijson.Field
PacketLoss apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedSummaryResponseSummary0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedSummaryResponseSummary0JSON) RawJSON() string {
return r.raw
}
type QualitySpeedHistogramParams struct {
// Array of comma separated list of ASNs, start with `-` to exclude from results.
// For example, `-174, 3356` excludes results from AS174, but includes results from
// AS3356.
ASN param.Field[[]string] `query:"asn"`
// The width for every bucket in the histogram.
BucketSize param.Field[int64] `query:"bucketSize"`
// Array of comma separated list of continents (alpha-2 continent codes). Start
// with `-` to exclude from results. For example, `-EU,NA` excludes results from
// Europe, but includes results from North America.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Format results are returned in.
Format param.Field[QualitySpeedHistogramParamsFormat] `query:"format"`
// Array of comma separated list of locations (alpha-2 country codes). Start with
// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
// but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Metrics to be returned.
MetricGroup param.Field[QualitySpeedHistogramParamsMetricGroup] `query:"metricGroup"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
}
// URLQuery serializes [QualitySpeedHistogramParams]'s query parameters as
// `url.Values`.
func (r QualitySpeedHistogramParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Format results are returned in.
type QualitySpeedHistogramParamsFormat string
const (
QualitySpeedHistogramParamsFormatJson QualitySpeedHistogramParamsFormat = "JSON"
QualitySpeedHistogramParamsFormatCsv QualitySpeedHistogramParamsFormat = "CSV"
)
func (r QualitySpeedHistogramParamsFormat) IsKnown() bool {
switch r {
case QualitySpeedHistogramParamsFormatJson, QualitySpeedHistogramParamsFormatCsv:
return true
}
return false
}
// Metrics to be returned.
type QualitySpeedHistogramParamsMetricGroup string
const (
QualitySpeedHistogramParamsMetricGroupBandwidth QualitySpeedHistogramParamsMetricGroup = "BANDWIDTH"
QualitySpeedHistogramParamsMetricGroupLatency QualitySpeedHistogramParamsMetricGroup = "LATENCY"
QualitySpeedHistogramParamsMetricGroupJitter QualitySpeedHistogramParamsMetricGroup = "JITTER"
)
func (r QualitySpeedHistogramParamsMetricGroup) IsKnown() bool {
switch r {
case QualitySpeedHistogramParamsMetricGroupBandwidth, QualitySpeedHistogramParamsMetricGroupLatency, QualitySpeedHistogramParamsMetricGroupJitter:
return true
}
return false
}
type QualitySpeedHistogramResponseEnvelope struct {
Result QualitySpeedHistogramResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON qualitySpeedHistogramResponseEnvelopeJSON `json:"-"`
}
// qualitySpeedHistogramResponseEnvelopeJSON contains the JSON metadata for the
// struct [QualitySpeedHistogramResponseEnvelope]
type qualitySpeedHistogramResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedHistogramResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedHistogramResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type QualitySpeedSummaryParams struct {
// Array of comma separated list of ASNs, start with `-` to exclude from results.
// For example, `-174, 3356` excludes results from AS174, but includes results from
// AS3356.
ASN param.Field[[]string] `query:"asn"`
// Array of comma separated list of continents (alpha-2 continent codes). Start
// with `-` to exclude from results. For example, `-EU,NA` excludes results from
// Europe, but includes results from North America.
Continent param.Field[[]string] `query:"continent"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// Format results are returned in.
Format param.Field[QualitySpeedSummaryParamsFormat] `query:"format"`
// Array of comma separated list of locations (alpha-2 country codes). Start with
// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
// but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
}
// URLQuery serializes [QualitySpeedSummaryParams]'s query parameters as
// `url.Values`.
func (r QualitySpeedSummaryParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Format results are returned in.
type QualitySpeedSummaryParamsFormat string
const (
QualitySpeedSummaryParamsFormatJson QualitySpeedSummaryParamsFormat = "JSON"
QualitySpeedSummaryParamsFormatCsv QualitySpeedSummaryParamsFormat = "CSV"
)
func (r QualitySpeedSummaryParamsFormat) IsKnown() bool {
switch r {
case QualitySpeedSummaryParamsFormatJson, QualitySpeedSummaryParamsFormatCsv:
return true
}
return false
}
type QualitySpeedSummaryResponseEnvelope struct {
Result QualitySpeedSummaryResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON qualitySpeedSummaryResponseEnvelopeJSON `json:"-"`
}
// qualitySpeedSummaryResponseEnvelopeJSON contains the JSON metadata for the
// struct [QualitySpeedSummaryResponseEnvelope]
type qualitySpeedSummaryResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *QualitySpeedSummaryResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r qualitySpeedSummaryResponseEnvelopeJSON) RawJSON() string {
return r.raw
}