-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
example_test.go
347 lines (313 loc) · 10 KB
/
example_test.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
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
package pubsublite_test
import (
"context"
"fmt"
"time"
"cloud.google.com/go/pubsublite"
"google.golang.org/api/iterator"
)
// This example demonstrates how to create a new topic. Topics may be regional
// or zonal. See https://cloud.google.com/pubsub/lite/docs/topics for more
// information about how Pub/Sub Lite topics are configured.
// See https://cloud.google.com/pubsub/lite/docs/locations for the list of
// regions and zones where Pub/Sub Lite is available.
func ExampleAdminClient_CreateTopic() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
const gib = 1 << 30
topicConfig := pubsublite.TopicConfig{
Name: "projects/my-project/locations/region-or-zone/topics/my-topic",
PartitionCount: 2, // Must be at least 1.
PublishCapacityMiBPerSec: 4, // Must be 4-16 MiB/s.
SubscribeCapacityMiBPerSec: 8, // Must be 4-32 MiB/s.
PerPartitionBytes: 30 * gib, // Must be 30 GiB-10 TiB.
// Retain messages indefinitely as long as there is available storage.
RetentionDuration: pubsublite.InfiniteRetention,
}
_, err = admin.CreateTopic(ctx, topicConfig)
if err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_UpdateTopic() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
updateConfig := pubsublite.TopicConfigToUpdate{
Name: "projects/my-project/locations/region-or-zone/topics/my-topic",
PartitionCount: 3, // Only increases currently supported.
PublishCapacityMiBPerSec: 8,
SubscribeCapacityMiBPerSec: 16,
RetentionDuration: 24 * time.Hour, // Garbage collect messages older than 24 hours.
}
_, err = admin.UpdateTopic(ctx, updateConfig)
if err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_DeleteTopic() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
const topic = "projects/my-project/locations/region-or-zone/topics/my-topic"
if err := admin.DeleteTopic(ctx, topic); err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_Topics() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
// List the configs of all topics in the given region or zone for the project.
it := admin.Topics(ctx, "projects/my-project/locations/region-or-zone")
for {
topicConfig, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
fmt.Println(topicConfig)
}
}
func ExampleAdminClient_TopicSubscriptions() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
// List the paths of all subscriptions of a topic.
const topic = "projects/my-project/locations/region-or-zone/topics/my-topic"
it := admin.TopicSubscriptions(ctx, topic)
for {
subscriptionPath, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
fmt.Println(subscriptionPath)
}
}
// This example demonstrates how to create a new subscription for a topic.
// See https://cloud.google.com/pubsub/lite/docs/subscriptions for more
// information about how subscriptions are configured.
func ExampleAdminClient_CreateSubscription() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
subscriptionConfig := pubsublite.SubscriptionConfig{
Name: "projects/my-project/locations/region-or-zone/subscriptions/my-subscription",
Topic: "projects/my-project/locations/region-or-zone/topics/my-topic",
// Do not wait for a published message to be successfully written to storage
// before delivering it to subscribers.
DeliveryRequirement: pubsublite.DeliverImmediately,
}
_, err = admin.CreateSubscription(ctx, subscriptionConfig)
if err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_UpdateSubscription() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
updateConfig := pubsublite.SubscriptionConfigToUpdate{
Name: "projects/my-project/locations/region-or-zone/subscriptions/my-subscription",
// Deliver a published message to subscribers after it has been successfully
// written to storage.
DeliveryRequirement: pubsublite.DeliverAfterStored,
}
_, err = admin.UpdateSubscription(ctx, updateConfig)
if err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_SeekSubscription() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
const subscription = "projects/my-project/locations/region-or-zone/subscriptions/my-subscription"
seekOp, err := admin.SeekSubscription(ctx, subscription, pubsublite.Beginning)
if err != nil {
// TODO: Handle error.
}
// Optional: Wait for the seek operation to complete, which indicates when
// subscribers for all partitions are receiving messages from the seek target.
_, err = seekOp.Wait(ctx)
if err != nil {
// TODO: Handle error.
}
metadata, err := seekOp.Metadata()
if err != nil {
// TODO: Handle error.
}
fmt.Println(metadata)
}
func ExampleAdminClient_DeleteSubscription() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
const subscription = "projects/my-project/locations/region-or-zone/subscriptions/my-subscription"
if err := admin.DeleteSubscription(ctx, subscription); err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_Subscriptions() {
ctx := context.Background()
// NOTE: resources must be located within this region.
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
// List the configs of all subscriptions in the given region or zone for the project.
it := admin.Subscriptions(ctx, "projects/my-project/locations/region-or-zone")
for {
subscriptionConfig, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
fmt.Println(subscriptionConfig)
}
}
// This example demonstrates how to create a new reservation.
// See https://cloud.google.com/pubsub/lite/docs/locations for the list of
// regions where Pub/Sub Lite is available.
func ExampleAdminClient_CreateReservation() {
ctx := context.Background()
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
reservationConfig := pubsublite.ReservationConfig{
Name: "projects/my-project/locations/region/reservations/my-reservation",
ThroughputCapacity: 10,
}
_, err = admin.CreateReservation(ctx, reservationConfig)
if err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_UpdateReservation() {
ctx := context.Background()
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
updateConfig := pubsublite.ReservationConfigToUpdate{
Name: "projects/my-project/locations/region/reservations/my-reservation",
ThroughputCapacity: 20,
}
_, err = admin.UpdateReservation(ctx, updateConfig)
if err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_DeleteReservation() {
ctx := context.Background()
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
const reservation = "projects/my-project/locations/region/reservations/my-reservation"
if err := admin.DeleteReservation(ctx, reservation); err != nil {
// TODO: Handle error.
}
}
func ExampleAdminClient_Reservations() {
ctx := context.Background()
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
// List the configs of all reservations in the given region for the project.
it := admin.Reservations(ctx, "projects/my-project/locations/region")
for {
reservation, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
fmt.Println(reservation)
}
}
func ExampleAdminClient_ReservationTopics() {
ctx := context.Background()
admin, err := pubsublite.NewAdminClient(ctx, "region")
if err != nil {
// TODO: Handle error.
}
defer admin.Close()
// List the paths of all topics using a reservation.
const reservation = "projects/my-project/locations/region/reservations/my-reservation"
it := admin.ReservationTopics(ctx, reservation)
for {
topicPath, err := it.Next()
if err == iterator.Done {
break
}
if err != nil {
// TODO: Handle error.
}
fmt.Println(topicPath)
}
}