iggy-cli 0.13.1-edge.1

CLI for Iggy message streaming platform
Documentation 
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

/* Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
 *
 *   http://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 limitations
 * under the License.
 */

use crate::args::common::ListMode;
use clap::{Args, Subcommand};
use iggy::prelude::Identifier;

#[derive(Debug, Clone, Subcommand)]
pub(crate) enum ConsumerGroupAction {
    /// Create consumer group with given ID and name for given stream ID and topic ID.
    ///
    /// Stream ID can be specified as a stream name or ID
    /// Topic ID can be specified as a topic name or ID
    /// If group ID is not provided then the server will automatically assign it
    ///
    /// Examples:
    ///  iggy consumer-group create 1 1 prod
    ///  iggy consumer-group create stream 2 test
    ///  iggy consumer-group create 2 topic receiver
    ///  iggy consumer-group create -g 4 stream topic group
    #[clap(verbatim_doc_comment, visible_alias = "c")]
    Create(ConsumerGroupCreateArgs),
    /// Delete consumer group with given ID for given stream ID and topic ID
    ///
    /// Stream ID can be specified as a stream name or ID
    /// Topic ID can be specified as a topic name or ID
    /// Consumer group ID can be specified as a consumer group name or ID
    ///
    /// Examples:
    ///  iggy consumer-group delete 1 2 3
    ///  iggy consumer-group delete stream 2 3
    ///  iggy consumer-group delete 1 topic 3
    ///  iggy consumer-group delete 1 2 group
    ///  iggy consumer-group delete stream topic 3
    ///  iggy consumer-group delete 1 topic group
    ///  iggy consumer-group delete stream 2 group
    ///  iggy consumer-group delete stream topic group
    #[clap(verbatim_doc_comment, visible_alias = "d")]
    Delete(ConsumerGroupDeleteArgs),
    /// Get details of a single consumer group with given ID for given stream ID and topic ID
    ///
    /// Stream ID can be specified as a stream name or ID
    /// Topic ID can be specified as a topic name or ID
    /// Consumer group ID can be specified as a consumer group name or ID
    ///
    /// Examples:
    ///  iggy consumer-group get 1 2 3
    ///  iggy consumer-group get stream 2 3
    ///  iggy consumer-group get 1 topic 3
    ///  iggy consumer-group get 1 2 group
    ///  iggy consumer-group get stream topic 3
    ///  iggy consumer-group get 1 topic group
    ///  iggy consumer-group get stream 2 group
    ///  iggy consumer-group get stream topic group
    #[clap(verbatim_doc_comment, visible_alias = "g")]
    Get(ConsumerGroupGetArgs),
    /// List all consumer groups for given stream ID and topic ID
    ///
    /// Stream ID can be specified as a stream name or ID
    /// Topic ID can be specified as a topic name or ID
    ///
    /// Examples:
    ///  iggy consumer-group list 1 1
    ///  iggy consumer-group list stream 2 --list-mode table
    ///  iggy consumer-group list 3 topic -l table
    ///  iggy consumer-group list production sensor -l table
    #[clap(verbatim_doc_comment, visible_alias = "l")]
    List(ConsumerGroupListArgs),
}

#[derive(Debug, Clone, Args)]
pub(crate) struct ConsumerGroupCreateArgs {
    /// Stream ID to create consumer group
    ///
    /// Stream ID can be specified as a stream name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) stream_id: Identifier,
    /// Topic ID to create consumer group
    ///
    /// Topic ID can be specified as a topic name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) topic_id: Identifier,
    /// Consumer group ID to create
    #[clap(short, long)]
    pub(crate) group_id: Option<u32>,
    /// Consumer group name to create
    pub(crate) name: String,
}

#[derive(Debug, Clone, Args)]
pub(crate) struct ConsumerGroupDeleteArgs {
    /// Stream ID to delete consumer group
    ///
    /// Stream ID can be specified as a stream name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) stream_id: Identifier,
    /// Topic ID to delete consumer group
    ///
    /// Topic ID can be specified as a topic name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) topic_id: Identifier,
    /// Consumer group ID to delete
    ///
    /// Consumer group ID can be specified as a consumer group name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) group_id: Identifier,
}

#[derive(Debug, Clone, Args)]
pub(crate) struct ConsumerGroupGetArgs {
    /// Stream ID to get consumer group
    ///
    /// Stream ID can be specified as a stream name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) stream_id: Identifier,
    /// Topic ID to get consumer group
    ///
    /// Topic ID can be specified as a topic name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) topic_id: Identifier,
    /// Consumer group ID to get
    ///
    /// Consumer group ID can be specified as a consumer group name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) group_id: Identifier,
}

#[derive(Debug, Clone, Args)]
pub(crate) struct ConsumerGroupListArgs {
    /// Stream ID to list consumer groups
    ///
    /// Stream ID can be specified as a stream name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) stream_id: Identifier,
    /// Topic ID to list consumer groups
    ///
    /// Topic ID can be specified as a topic name or ID
    #[arg(value_parser = clap::value_parser!(Identifier))]
    pub(crate) topic_id: Identifier,
    /// List mode (table or list)
    #[clap(short, long, value_enum, default_value_t = ListMode::Table)]
    pub(crate) list_mode: ListMode,
}