grpc.channelz.v1.channelz

1 // Generated by the protocol buffer compiler.  DO NOT EDIT!
2 // source: channelz.proto
3 
4 module grpc.channelz.v1.channelz_;
5 
6 import google.protobuf;
7 import google.rpc.status;
8 import google.protobuf.any;
9 import google.protobuf.duration;
10 import google.protobuf.timestamp;
11 import google.protobuf.wrappers;
12 
13 enum protocVersion = 3010000;
14 
15 struct Channel
16 {
17     @Proto(1) ChannelRef ref_ = protoDefaultValue!ChannelRef;
18     @Proto(2) ChannelData data = protoDefaultValue!ChannelData;
19     @Proto(3) ChannelRef[] channelRef = protoDefaultValue!(ChannelRef[]);
20     @Proto(4) SubchannelRef[] subchannelRef = protoDefaultValue!(SubchannelRef[]);
21     @Proto(5) SocketRef[] socketRef = protoDefaultValue!(SocketRef[]);
22 }
23 
24 struct Subchannel
25 {
26     @Proto(1) SubchannelRef ref_ = protoDefaultValue!SubchannelRef;
27     @Proto(2) ChannelData data = protoDefaultValue!ChannelData;
28     @Proto(3) ChannelRef[] channelRef = protoDefaultValue!(ChannelRef[]);
29     @Proto(4) SubchannelRef[] subchannelRef = protoDefaultValue!(SubchannelRef[]);
30     @Proto(5) SocketRef[] socketRef = protoDefaultValue!(SocketRef[]);
31 }
32 
33 struct ChannelConnectivityState
34 {
35     @Proto(1) State state = protoDefaultValue!State;
36 
37     enum State
38     {
39         UNKNOWN = 0,
40         IDLE = 1,
41         CONNECTING = 2,
42         READY = 3,
43         TRANSIENT_FAILURE = 4,
44         SHUTDOWN = 5,
45     }
46 }
47 
48 struct ChannelData
49 {
50     @Proto(1) ChannelConnectivityState state = protoDefaultValue!ChannelConnectivityState;
51     @Proto(2) string target = protoDefaultValue!string;
52     @Proto(3) ChannelTrace trace = protoDefaultValue!ChannelTrace;
53     @Proto(4) long callsStarted = protoDefaultValue!long;
54     @Proto(5) long callsSucceeded = protoDefaultValue!long;
55     @Proto(6) long callsFailed = protoDefaultValue!long;
56     @Proto(7) Timestamp lastCallStartedTimestamp = protoDefaultValue!Timestamp;
57 }
58 
59 struct ChannelTraceEvent
60 {
61     @Proto(1) string description = protoDefaultValue!string;
62     @Proto(2) Severity severity = protoDefaultValue!Severity;
63     @Proto(3) Timestamp timestamp = protoDefaultValue!Timestamp;
64     enum ChildRefCase
65     {
66         childRefNotSet = 0,
67         channelRef = 4,
68         subchannelRef = 5,
69     }
70     ChildRefCase _childRefCase = ChildRefCase.childRefNotSet;
71     @property ChildRefCase childRefCase() { return _childRefCase; }
72     void clearChildRef() { _childRefCase = ChildRefCase.childRefNotSet; }
73     @Oneof("_childRefCase") union
74     {
75         @Proto(4) ChannelRef _channelRef = protoDefaultValue!ChannelRef; mixin(oneofAccessors!_channelRef);
76         @Proto(5) SubchannelRef _subchannelRef; mixin(oneofAccessors!_subchannelRef);
77     }
78 
79     enum Severity
80     {
81         CT_UNKNOWN = 0,
82         CT_INFO = 1,
83         CT_WARNING = 2,
84         CT_ERROR = 3,
85     }
86 }
87 
88 struct ChannelTrace
89 {
90     @Proto(1) long numEventsLogged = protoDefaultValue!long;
91     @Proto(2) Timestamp creationTimestamp = protoDefaultValue!Timestamp;
92     @Proto(3) ChannelTraceEvent[] events = protoDefaultValue!(ChannelTraceEvent[]);
93 }
94 
95 struct ChannelRef
96 {
97     @Proto(1) long channelId = protoDefaultValue!long;
98     @Proto(2) string name = protoDefaultValue!string;
99 }
100 
101 struct SubchannelRef
102 {
103     @Proto(7) long subchannelId = protoDefaultValue!long;
104     @Proto(8) string name = protoDefaultValue!string;
105 }
106 
107 struct SocketRef
108 {
109     @Proto(3) long socketId = protoDefaultValue!long;
110     @Proto(4) string name = protoDefaultValue!string;
111 }
112 
113 struct ServerRef
114 {
115     @Proto(5) long serverId = protoDefaultValue!long;
116     @Proto(6) string name = protoDefaultValue!string;
117 }
118 
119 struct Server
120 {
121     @Proto(1) ServerRef ref_ = protoDefaultValue!ServerRef;
122     @Proto(2) ServerData data = protoDefaultValue!ServerData;
123     @Proto(3) SocketRef[] listenSocket = protoDefaultValue!(SocketRef[]);
124 }
125 
126 struct ServerData
127 {
128 //    @Proto(1) ChannelTrace trace = protoDefaultValue!ChannelTrace;
129     @Proto(2) long callsStarted = protoDefaultValue!long;
130     @Proto(3) long callsSucceeded = protoDefaultValue!long;
131     @Proto(4) long callsFailed = protoDefaultValue!long;
132 //    @Proto(5) Timestamp lastCallStartedTimestamp = protoDefaultValue!Timestamp;
133 }
134 
135 struct Socket
136 {
137     @Proto(1) SocketRef ref_ = protoDefaultValue!SocketRef;
138     @Proto(2) SocketData data = protoDefaultValue!SocketData;
139     @Proto(3) Address local = protoDefaultValue!Address;
140     @Proto(4) Address remote = protoDefaultValue!Address;
141     @Proto(5) Security security = protoDefaultValue!Security;
142     @Proto(6) string remoteName = protoDefaultValue!string;
143 }
144 
145 struct SocketData
146 {
147     @Proto(1) long streamsStarted = protoDefaultValue!long;
148     @Proto(2) long streamsSucceeded = protoDefaultValue!long;
149     @Proto(3) long streamsFailed = protoDefaultValue!long;
150     @Proto(4) long messagesSent = protoDefaultValue!long;
151     @Proto(5) long messagesReceived = protoDefaultValue!long;
152     @Proto(6) long keepAlivesSent = protoDefaultValue!long;
153     @Proto(7) Timestamp lastLocalStreamCreatedTimestamp = protoDefaultValue!Timestamp;
154     @Proto(8) Timestamp lastRemoteStreamCreatedTimestamp = protoDefaultValue!Timestamp;
155     @Proto(9) Timestamp lastMessageSentTimestamp = protoDefaultValue!Timestamp;
156     @Proto(10) Timestamp lastMessageReceivedTimestamp = protoDefaultValue!Timestamp;
157     @Proto(11) Int64Value localFlowControlWindow = protoDefaultValue!Int64Value;
158     @Proto(12) Int64Value remoteFlowControlWindow = protoDefaultValue!Int64Value;
159     @Proto(13) SocketOption[] option = protoDefaultValue!(SocketOption[]);
160 }
161 
162 struct Address
163 {
164     enum AddressCase
165     {
166         addressNotSet = 0,
167         tcpipAddress = 1,
168         udsAddress = 2,
169         otherAddress = 3,
170     }
171     AddressCase _addressCase = AddressCase.addressNotSet;
172     @property AddressCase addressCase() { return _addressCase; }
173     void clearAddress() { _addressCase = AddressCase.addressNotSet; }
174     @Oneof("_addressCase") union
175     {
176         @Proto(1) TcpIpAddress _tcpipAddress = protoDefaultValue!TcpIpAddress; mixin(oneofAccessors!_tcpipAddress);
177         @Proto(2) UdsAddress _udsAddress; mixin(oneofAccessors!_udsAddress);
178         @Proto(3) OtherAddress _otherAddress; mixin(oneofAccessors!_otherAddress);
179     }
180 
181     static struct TcpIpAddress
182     {
183         @Proto(1) bytes ipAddress = protoDefaultValue!bytes;
184         @Proto(2) int port = protoDefaultValue!int;
185     }
186 
187     static struct UdsAddress
188     {
189         @Proto(1) string filename = protoDefaultValue!string;
190     }
191 
192     static struct OtherAddress
193     {
194         @Proto(1) string name = protoDefaultValue!string;
195         @Proto(2) Any value = protoDefaultValue!Any;
196     }
197 }
198 
199 struct Security
200 {
201     enum ModelCase
202     {
203         modelNotSet = 0,
204         tls = 1,
205         other = 2,
206     }
207     ModelCase _modelCase = ModelCase.modelNotSet;
208     @property ModelCase modelCase() { return _modelCase; }
209     void clearModel() { _modelCase = ModelCase.modelNotSet; }
210     @Oneof("_modelCase") union
211     {
212         @Proto(1) Tls _tls = protoDefaultValue!Tls; mixin(oneofAccessors!_tls);
213         @Proto(2) OtherSecurity _other; mixin(oneofAccessors!_other);
214     }
215 
216     static struct Tls
217     {
218         enum CipherSuiteCase
219         {
220             cipherSuiteNotSet = 0,
221             standardName = 1,
222             otherName = 2,
223         }
224         CipherSuiteCase _cipherSuiteCase = CipherSuiteCase.cipherSuiteNotSet;
225         @property CipherSuiteCase cipherSuiteCase() { return _cipherSuiteCase; }
226         void clearCipherSuite() { _cipherSuiteCase = CipherSuiteCase.cipherSuiteNotSet; }
227         @Oneof("_cipherSuiteCase") union
228         {
229             @Proto(1) string _standardName = protoDefaultValue!string; mixin(oneofAccessors!_standardName);
230             @Proto(2) string _otherName; mixin(oneofAccessors!_otherName);
231         }
232         @Proto(3) bytes localCertificate = protoDefaultValue!bytes;
233         @Proto(4) bytes remoteCertificate = protoDefaultValue!bytes;
234     }
235 
236     static struct OtherSecurity
237     {
238         @Proto(1) string name = protoDefaultValue!string;
239         @Proto(2) Any value = protoDefaultValue!Any;
240     }
241 }
242 
243 struct SocketOption
244 {
245     @Proto(1) string name = protoDefaultValue!string;
246     @Proto(2) string value = protoDefaultValue!string;
247     @Proto(3) Any additional = protoDefaultValue!Any;
248 }
249 
250 struct SocketOptionTimeout
251 {
252     @Proto(1) Duration duration = protoDefaultValue!Duration;
253 }
254 
255 struct SocketOptionLinger
256 {
257     @Proto(1) bool active = protoDefaultValue!bool;
258     @Proto(2) Duration duration = protoDefaultValue!Duration;
259 }
260 
261 struct SocketOptionTcpInfo
262 {
263     @Proto(1) uint tcpiState = protoDefaultValue!uint;
264     @Proto(2) uint tcpiCaState = protoDefaultValue!uint;
265     @Proto(3) uint tcpiRetransmits = protoDefaultValue!uint;
266     @Proto(4) uint tcpiProbes = protoDefaultValue!uint;
267     @Proto(5) uint tcpiBackoff = protoDefaultValue!uint;
268     @Proto(6) uint tcpiOptions = protoDefaultValue!uint;
269     @Proto(7) uint tcpiSndWscale = protoDefaultValue!uint;
270     @Proto(8) uint tcpiRcvWscale = protoDefaultValue!uint;
271     @Proto(9) uint tcpiRto = protoDefaultValue!uint;
272     @Proto(10) uint tcpiAto = protoDefaultValue!uint;
273     @Proto(11) uint tcpiSndMss = protoDefaultValue!uint;
274     @Proto(12) uint tcpiRcvMss = protoDefaultValue!uint;
275     @Proto(13) uint tcpiUnacked = protoDefaultValue!uint;
276     @Proto(14) uint tcpiSacked = protoDefaultValue!uint;
277     @Proto(15) uint tcpiLost = protoDefaultValue!uint;
278     @Proto(16) uint tcpiRetrans = protoDefaultValue!uint;
279     @Proto(17) uint tcpiFackets = protoDefaultValue!uint;
280     @Proto(18) uint tcpiLastDataSent = protoDefaultValue!uint;
281     @Proto(19) uint tcpiLastAckSent = protoDefaultValue!uint;
282     @Proto(20) uint tcpiLastDataRecv = protoDefaultValue!uint;
283     @Proto(21) uint tcpiLastAckRecv = protoDefaultValue!uint;
284     @Proto(22) uint tcpiPmtu = protoDefaultValue!uint;
285     @Proto(23) uint tcpiRcvSsthresh = protoDefaultValue!uint;
286     @Proto(24) uint tcpiRtt = protoDefaultValue!uint;
287     @Proto(25) uint tcpiRttvar = protoDefaultValue!uint;
288     @Proto(26) uint tcpiSndSsthresh = protoDefaultValue!uint;
289     @Proto(27) uint tcpiSndCwnd = protoDefaultValue!uint;
290     @Proto(28) uint tcpiAdvmss = protoDefaultValue!uint;
291     @Proto(29) uint tcpiReordering = protoDefaultValue!uint;
292 }
293 
294 struct GetTopChannelsRequest
295 {
296     @Proto(1) long startChannelId = protoDefaultValue!long;
297     @Proto(2) long maxResults = protoDefaultValue!long;
298 }
299 
300 struct GetTopChannelsResponse
301 {
302     @Proto(1) Channel[] channel = protoDefaultValue!(Channel[]);
303     @Proto(2) bool end = protoDefaultValue!bool;
304 }
305 
306 struct GetServersRequest
307 {
308     @Proto(1) long startServerId = protoDefaultValue!long;
309     @Proto(2) long maxResults = protoDefaultValue!long;
310 }
311 
312 struct GetServersResponse
313 {
314     @Proto(1) Server[] server = protoDefaultValue!(Server[]);
315     @Proto(2) bool end = protoDefaultValue!bool;
316 }
317 
318 struct GetServerRequest
319 {
320     @Proto(1) long serverId = protoDefaultValue!long;
321 }
322 
323 struct GetServerResponse
324 {
325     @Proto(1) Server server = protoDefaultValue!Server;
326 }
327 
328 struct GetServerSocketsRequest
329 {
330     @Proto(1) long serverId = protoDefaultValue!long;
331     @Proto(2) long startSocketId = protoDefaultValue!long;
332     @Proto(3) long maxResults = protoDefaultValue!long;
333 }
334 
335 struct GetServerSocketsResponse
336 {
337     @Proto(1) SocketRef[] socketRef = protoDefaultValue!(SocketRef[]);
338     @Proto(2) bool end = protoDefaultValue!bool;
339 }
340 
341 struct GetChannelRequest
342 {
343     @Proto(1) long channelId = protoDefaultValue!long;
344 }
345 
346 struct GetChannelResponse
347 {
348     @Proto(1) Channel channel = protoDefaultValue!Channel;
349 }
350 
351 struct GetSubchannelRequest
352 {
353     @Proto(1) long subchannelId = protoDefaultValue!long;
354 }
355 
356 struct GetSubchannelResponse
357 {
358     @Proto(1) Subchannel subchannel = protoDefaultValue!Subchannel;
359 }
360 
361 struct GetSocketRequest
362 {
363     @Proto(1) long socketId = protoDefaultValue!long;
364     @Proto(2) bool summary = protoDefaultValue!bool;
365 }
366 
367 struct GetSocketResponse
368 {
369     @Proto(1) Socket socket = protoDefaultValue!Socket;
370 }
371 
372 interface Channelz
373 {
374     @RPC("/grpc.channelz.v1.Channelz/GetTopChannels")
375     Status GetTopChannels(GetTopChannelsRequest, ref GetTopChannelsResponse);
376 
377     @RPC("/grpc.channelz.v1.Channelz/GetServers")
378     Status GetServers(GetServersRequest, ref GetServersResponse);
379 
380     @RPC("/grpc.channelz.v1.Channelz/GetServer")
381     Status GetServer(GetServerRequest, ref GetServerResponse);
382 
383     @RPC("/grpc.channelz.v1.Channelz/GetServerSockets")
384     Status GetServerSockets(GetServerSocketsRequest, ref GetServerSocketsResponse);
385 
386     @RPC("/grpc.channelz.v1.Channelz/GetChannel")
387     Status GetChannel(GetChannelRequest, ref GetChannelResponse);
388 
389     @RPC("/grpc.channelz.v1.Channelz/GetSubchannel")
390     Status GetSubchannel(GetSubchannelRequest, ref GetSubchannelResponse);
391 
392     @RPC("/grpc.channelz.v1.Channelz/GetSocket")
393     Status GetSocket(GetSocketRequest, ref GetSocketResponse);
394 
395 }