-
Notifications
You must be signed in to change notification settings - Fork 541
/
message.go
314 lines (269 loc) · 10 KB
/
message.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package queues
import (
"context"
"fmt"
"net/http"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"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"
)
// MessageService 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 [NewMessageService] method instead.
type MessageService struct {
Options []option.RequestOption
}
// NewMessageService 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 NewMessageService(opts ...option.RequestOption) (r *MessageService) {
r = &MessageService{}
r.Options = opts
return
}
// Acknowledge + Retry messages from a Queue.
func (r *MessageService) Ack(ctx context.Context, queueID string, params MessageAckParams, opts ...option.RequestOption) (res *MessageAckResponse, err error) {
opts = append(r.Options[:], opts...)
var env MessageAckResponseEnvelope
path := fmt.Sprintf("accounts/%s/queues/%s/messages/ack", params.AccountID, queueID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Pull a batch of messages from a Queue.
func (r *MessageService) Pull(ctx context.Context, queueID string, params MessagePullParams, opts ...option.RequestOption) (res *[]MessagePullResponse, err error) {
opts = append(r.Options[:], opts...)
var env MessagePullResponseEnvelope
path := fmt.Sprintf("accounts/%s/queues/%s/messages/pull", params.AccountID, queueID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type MessageAckResponse struct {
// The number of messages that were succesfully acknowledged
AckCount float64 `json:"ackCount"`
// The number of messages that were succesfully retried
RetryCount float64 `json:"retryCount"`
Warnings []string `json:"warnings"`
JSON messageAckResponseJSON `json:"-"`
}
// messageAckResponseJSON contains the JSON metadata for the struct
// [MessageAckResponse]
type messageAckResponseJSON struct {
AckCount apijson.Field
RetryCount apijson.Field
Warnings apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *MessageAckResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r messageAckResponseJSON) RawJSON() string {
return r.raw
}
type MessagePullResponse struct {
ID string `json:"id"`
Attempts float64 `json:"attempts"`
Body string `json:"body"`
LeaseID string `json:"lease_id"`
Metadata interface{} `json:"metadata"`
TimestampMs float64 `json:"timestamp_ms"`
JSON messagePullResponseJSON `json:"-"`
}
// messagePullResponseJSON contains the JSON metadata for the struct
// [MessagePullResponse]
type messagePullResponseJSON struct {
ID apijson.Field
Attempts apijson.Field
Body apijson.Field
LeaseID apijson.Field
Metadata apijson.Field
TimestampMs apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *MessagePullResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r messagePullResponseJSON) RawJSON() string {
return r.raw
}
type MessageAckParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
Acks param.Field[[]MessageAckParamsAck] `json:"acks"`
Retries param.Field[[]MessageAckParamsRetry] `json:"retries"`
}
func (r MessageAckParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type MessageAckParamsAck struct {
// Lease ID for a message to acknowledge.
LeaseID param.Field[string] `json:"lease_id"`
}
func (r MessageAckParamsAck) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type MessageAckParamsRetry struct {
// The number of seconds to delay before making the message available for another
// attempt.
DelaySeconds param.Field[float64] `json:"delay_seconds"`
// Lease ID for a message to retry.
LeaseID param.Field[string] `json:"lease_id"`
}
func (r MessageAckParamsRetry) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type MessageAckResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result MessageAckResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success MessageAckResponseEnvelopeSuccess `json:"success,required"`
ResultInfo MessageAckResponseEnvelopeResultInfo `json:"result_info"`
JSON messageAckResponseEnvelopeJSON `json:"-"`
}
// messageAckResponseEnvelopeJSON contains the JSON metadata for the struct
// [MessageAckResponseEnvelope]
type messageAckResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
ResultInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *MessageAckResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r messageAckResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type MessageAckResponseEnvelopeSuccess bool
const (
MessageAckResponseEnvelopeSuccessTrue MessageAckResponseEnvelopeSuccess = true
)
func (r MessageAckResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case MessageAckResponseEnvelopeSuccessTrue:
return true
}
return false
}
type MessageAckResponseEnvelopeResultInfo struct {
// Total number of results for the requested service
Count float64 `json:"count"`
// Current page within paginated list of results
Page float64 `json:"page"`
// Number of results per page of results
PerPage float64 `json:"per_page"`
// Total results available without any search parameters
TotalCount float64 `json:"total_count"`
JSON messageAckResponseEnvelopeResultInfoJSON `json:"-"`
}
// messageAckResponseEnvelopeResultInfoJSON contains the JSON metadata for the
// struct [MessageAckResponseEnvelopeResultInfo]
type messageAckResponseEnvelopeResultInfoJSON struct {
Count apijson.Field
Page apijson.Field
PerPage apijson.Field
TotalCount apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *MessageAckResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r messageAckResponseEnvelopeResultInfoJSON) RawJSON() string {
return r.raw
}
type MessagePullParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The maximum number of messages to include in a batch
BatchSize param.Field[float64] `json:"batch_size"`
// The number of milliseconds that a message is exclusively leased. After the
// timeout, the message becomes available for another attempt.
VisibilityTimeoutMs param.Field[float64] `json:"visibility_timeout_ms"`
}
func (r MessagePullParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type MessagePullResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result []MessagePullResponse `json:"result,required,nullable"`
// Whether the API call was successful
Success MessagePullResponseEnvelopeSuccess `json:"success,required"`
ResultInfo MessagePullResponseEnvelopeResultInfo `json:"result_info"`
JSON messagePullResponseEnvelopeJSON `json:"-"`
}
// messagePullResponseEnvelopeJSON contains the JSON metadata for the struct
// [MessagePullResponseEnvelope]
type messagePullResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
ResultInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *MessagePullResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r messagePullResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type MessagePullResponseEnvelopeSuccess bool
const (
MessagePullResponseEnvelopeSuccessTrue MessagePullResponseEnvelopeSuccess = true
)
func (r MessagePullResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case MessagePullResponseEnvelopeSuccessTrue:
return true
}
return false
}
type MessagePullResponseEnvelopeResultInfo struct {
// Total number of results for the requested service
Count float64 `json:"count"`
// Current page within paginated list of results
Page float64 `json:"page"`
// Number of results per page of results
PerPage float64 `json:"per_page"`
// Total results available without any search parameters
TotalCount float64 `json:"total_count"`
JSON messagePullResponseEnvelopeResultInfoJSON `json:"-"`
}
// messagePullResponseEnvelopeResultInfoJSON contains the JSON metadata for the
// struct [MessagePullResponseEnvelopeResultInfo]
type messagePullResponseEnvelopeResultInfoJSON struct {
Count apijson.Field
Page apijson.Field
PerPage apijson.Field
TotalCount apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *MessagePullResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r messagePullResponseEnvelopeResultInfoJSON) RawJSON() string {
return r.raw
}