src/commands/xclaim.json


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

{
    "XCLAIM": {
        "summary": "Changes, or acquires, ownership of a message in a consumer group, as if the message was delivered a consumer group member.",
        "complexity": "O(log N) with N being the number of messages in the PEL of the consumer group.",
        "group": "stream",
        "since": "5.0.0",
        "arity": -6,
        "function": "xclaimCommand",
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "UPDATE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "group",
                "type": "string"
            },
            {
                "name": "consumer",
                "type": "string"
            },
            {
                "name": "min-idle-time",
                "type": "string"
            },
            {
                "name": "ID",
                "type": "string",
                "multiple": true
            },
            {
                "token": "IDLE",
                "name": "ms",
                "type": "integer",
                "optional": true
            },
            {
                "token": "TIME",
                "name": "unix-time-milliseconds",
                "type": "unix-time",
                "optional": true
            },
            {
                "token": "RETRYCOUNT",
                "name": "count",
                "type": "integer",
                "optional": true
            },
            {
                "name": "force",
                "token": "FORCE",
                "type": "pure-token",
                "optional": true
            },
            {
                "name": "justid",
                "token": "JUSTID",
                "type": "pure-token",
                "optional": true
            },
            {
                "name": "lastid",
                "token": "LASTID",
                "type": "string",
                "optional": true
            }
        ],
        "reply_schema": {
            "description": "Stream entries with IDs matching the specified range.",
            "anyOf": [
                {
                    "description": "If JUSTID option is specified, return just an array of IDs of messages successfully claimed",
                    "type": "array",
                    "items": {
                        "description": "Entry ID",
                        "type": "string",
                        "pattern": "[0-9]+-[0-9]+"
                    }
                },
                {
                    "description": "array of stream entries that contains each entry as an array of 2 elements, the Entry ID and the entry data itself",
                    "type": "array",
                    "uniqueItems": true,
                    "items": {
                        "type": "array",
                        "minItems": 2,
                        "maxItems": 2,
                        "items": [
                            {
                                "description": "Entry ID",
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            },
                            {
                                "description": "Data",
                                "type": "array",
                                "items": {
                                    "type": "string"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }
}