-
Notifications
You must be signed in to change notification settings - Fork 542
/
rayid.go
111 lines (98 loc) · 4.55 KB
/
rayid.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package logs
import (
"context"
"fmt"
"net/http"
"net/url"
"reflect"
"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"
"github.com/cloudflare/cloudflare-go/v2/shared"
"github.com/tidwall/gjson"
)
// RayIDService 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 [NewRayIDService] method instead.
type RayIDService struct {
Options []option.RequestOption
}
// NewRayIDService 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 NewRayIDService(opts ...option.RequestOption) (r *RayIDService) {
r = &RayIDService{}
r.Options = opts
return
}
// The `/rayids` api route allows lookups by specific rayid. The rayids route will
// return zero, one, or more records (ray ids are not unique).
func (r *RayIDService) Get(ctx context.Context, zoneIdentifier string, rayIdentifier string, query RayIDGetParams, opts ...option.RequestOption) (res *RayIDGetResponseUnion, err error) {
opts = append(r.Options[:], opts...)
path := fmt.Sprintf("zones/%s/logs/rayids/%s", zoneIdentifier, rayIdentifier)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &res, opts...)
return
}
// Union satisfied by [shared.UnionString] or [logs.RayIDGetResponseUnknown].
type RayIDGetResponseUnion interface {
ImplementsLogsRayIDGetResponseUnion()
}
func init() {
apijson.RegisterUnion(
reflect.TypeOf((*RayIDGetResponseUnion)(nil)).Elem(),
"",
apijson.UnionVariant{
TypeFilter: gjson.String,
Type: reflect.TypeOf(shared.UnionString("")),
},
)
}
type RayIDGetParams struct {
// The `/received` route by default returns a limited set of fields, and allows
// customers to override the default field set by specifying individual fields. The
// reasons for this are: 1. Most customers require only a small subset of fields,
// but that subset varies from customer to customer; 2. Flat schema is much easier
// to work with downstream (importing into BigTable etc); 3. Performance (time to
// process, file size). If `?fields=` is not specified, default field set is
// returned. This default field set may change at any time. When `?fields=` is
// provided, each record is returned with the specified fields. `fields` must be
// specified as a comma separated list without any whitespaces, and all fields must
// exist. The order in which fields are specified does not matter, and the order of
// fields in the response is not specified.
Fields param.Field[string] `query:"fields"`
// By default, timestamps in responses are returned as Unix nanosecond integers.
// The `?timestamps=` argument can be set to change the format in which response
// timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`.
// Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns
// timestamps as strings.
Timestamps param.Field[RayIDGetParamsTimestamps] `query:"timestamps"`
}
// URLQuery serializes [RayIDGetParams]'s query parameters as `url.Values`.
func (r RayIDGetParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// By default, timestamps in responses are returned as Unix nanosecond integers.
// The `?timestamps=` argument can be set to change the format in which response
// timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`.
// Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns
// timestamps as strings.
type RayIDGetParamsTimestamps string
const (
RayIDGetParamsTimestampsUnix RayIDGetParamsTimestamps = "unix"
RayIDGetParamsTimestampsUnixnano RayIDGetParamsTimestamps = "unixnano"
RayIDGetParamsTimestampsRfc3339 RayIDGetParamsTimestamps = "rfc3339"
)
func (r RayIDGetParamsTimestamps) IsKnown() bool {
switch r {
case RayIDGetParamsTimestampsUnix, RayIDGetParamsTimestampsUnixnano, RayIDGetParamsTimestampsRfc3339:
return true
}
return false
}