src/commands/xautoclaim.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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

{
    "XAUTOCLAIM": {
        "summary": "Changes, or acquires, ownership of messages in a consumer group, as if the messages were delivered to as consumer group member.",
        "complexity": "O(1) if COUNT is small.",
        "group": "stream",
        "since": "6.2.0",
        "arity": -6,
        "function": "xautoclaimCommand",
        "history": [
            [
                "7.0.0",
                "Added an element to the reply array, containing deleted entries the command cleared from the PEL"
            ]
        ],
        "command_flags": [
            "WRITE",
            "FAST"
        ],
        "acl_categories": [
            "STREAM"
        ],
        "command_tips": [
            "NONDETERMINISTIC_OUTPUT"
        ],
        "key_specs": [
            {
                "flags": [
                    "RW",
                    "DELETE"
                ],
                "begin_search": {
                    "index": {
                        "pos": 1
                    }
                },
                "find_keys": {
                    "range": {
                        "lastkey": 0,
                        "step": 1,
                        "limit": 0
                    }
                }
            }
        ],
        "reply_schema": {
            "anyOf": [
                {
                    "description": "Claimed stream entries (with data, if `JUSTID` was not given).",
                    "type": "array",
                    "minItems": 3,
                    "maxItems": 3,
                    "items": [
                        {
                            "description": "Cursor for next call.",
                            "type": "string",
                            "pattern": "[0-9]+-[0-9]+"
                        },
                        {
                            "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"
                                        }
                                    }
                                ]
                            }
                        },
                        {
                            "description": "Entry IDs which no longer exist in the stream, and were deleted from the PEL in which they were found.",
                            "type": "array",
                            "items": {
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            }
                        }
                    ]
                },
                {
                    "description": "Claimed stream entries (without data, if `JUSTID` was given).",
                    "type": "array",
                    "minItems": 3,
                    "maxItems": 3,
                    "items": [
                        {
                            "description": "Cursor for next call.",
                            "type": "string",
                            "pattern": "[0-9]+-[0-9]+"
                        },
                        {
                            "type": "array",
                            "uniqueItems": true,
                            "items": {
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            }
                        },
                        {
                            "description": "Entry IDs which no longer exist in the stream, and were deleted from the PEL in which they were found.",
                            "type": "array",
                            "items": {
                                "type": "string",
                                "pattern": "[0-9]+-[0-9]+"
                            }
                        }
                    ]
                }
            ]
        },
        "arguments": [
            {
                "name": "key",
                "type": "key",
                "key_spec_index": 0
            },
            {
                "name": "group",
                "type": "string"
            },
            {
                "name": "consumer",
                "type": "string"
            },
            {
                "name": "min-idle-time",
                "type": "string"
            },
            {
                "name": "start",
                "type": "string"
            },
            {
                "token": "COUNT",
                "name": "count",
                "type": "integer",
                "optional": true
            },
            {
                "name": "justid",
                "token": "JUSTID",
                "type": "pure-token",
                "optional": true
            }
        ]
    }
}