File: doc.go

package info (click to toggle)
golang-github-gophercloud-gophercloud 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,416 kB
  • sloc: sh: 99; makefile: 21
file content (111 lines) | stat: -rw-r--r-- 2,338 bytes parent folder | download
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
/*
Package queues provides information and interaction with the queues through
the OpenStack Messaging (Zaqar) service.

Lists all queues and creates, shows information for updates, deletes, and actions on a queue.

Example to List Queues

		listOpts := queues.ListOpts{
			Limit: 10,
		}

		pager := queues.List(client, listOpts)

	    err = pager.EachPage(func(page pagination.Page) (bool, error) {
			queues, err := queues.ExtractQueues(page)
			if err != nil {
				panic(err)
			}

			for _, queue := range queues {
				fmt.Printf("%+v\n", queue)
			}

			return true, nil
		})

Example to Create a Queue

	createOpts := queues.CreateOpts{
		QueueName:                  "My_Queue",
		MaxMessagesPostSize:        262143,
		DefaultMessageTTL:          3700,
		DefaultMessageDelay:        25,
		DeadLetterQueueMessageTTL:  3500,
		MaxClaimCount:              10,
		Extra:                      map[string]interface{}{"description": "Test queue."},
	}

	err := queues.Create(client, createOpts).ExtractErr()
	if err != nil {
		panic(err)
	}

Example to Update a Queue

	updateOpts := queues.BatchUpdateOpts{
		queues.UpdateOpts{
			Op:    "replace",
			Path:  "/metadata/_max_claim_count",
			Value: 15,
		},
		queues.UpdateOpts{
			Op: "replace",
			Path: "/metadata/description",
			Value: "Updated description test queue.",
		},
	}

	updateResult, err := queues.Update(client, queueName, updateOpts).Extract()
	if err != nil {
		panic(err)
	}

Example to Get a Queue

	queue, err := queues.Get(client, queueName).Extract()
	if err != nil {
		panic(err)
	}

Example to Delete a Queue

	err := queues.Delete(client, queueName).ExtractErr()
	if err != nil {
		panic(err)
	}

Example to Get Message Stats of a Queue

	queueStats, err := queues.GetStats(client, queueName).Extract()
	if err != nil {
		panic(err)
	}

Example to Share a queue

	shareOpts := queues.ShareOpts{
		Paths:   []queues.SharePath{queues.ShareMessages},
		Methods: []queues.ShareMethod{queues.MethodGet},
	}

	queueShare, err := queues.Share(client, queueName, shareOpts).Extract()
	if err != nil {
		panic(err)
	}

Example to Purge a queue

	purgeOpts := queues.PurgeOpts{
		ResourceTypes: []queues.PurgeResource{
			queues.ResourceMessages,
		},
	}

	err := queues.Purge(client, queueName, purgeOpts).ExtractErr()
	if err != nil {
		panic(err)
	}
*/
package queues