pulsar-admin-sdk 2.2.0

This provides the REST API for admin operations
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330

# \DefaultApi

All URIs are relative to */admin/v2*

Method | HTTP request | Description
------------- | ------------- | -------------
[**worker_drain**](DefaultApi.md#worker_drain) | **PUT** /worker/drain | Drains this worker, i.e., moves its work-assignments to other workers
[**worker_drain_at_leader**](DefaultApi.md#worker_drain_at_leader) | **PUT** /worker/leader/drain | Drains the specified worker, i.e., moves its work-assignments to other workers
[**worker_get_assignments**](DefaultApi.md#worker_get_assignments) | **GET** /worker/assignments | Fetches information about which Pulsar Functions are assigned to which Pulsar clusters
[**worker_get_cluster**](DefaultApi.md#worker_get_cluster) | **GET** /worker/cluster | Fetches information about the Pulsar cluster running Pulsar Functions
[**worker_get_cluster_leader**](DefaultApi.md#worker_get_cluster_leader) | **GET** /worker/cluster/leader | Fetches info about the leader node of the Pulsar cluster running Pulsar Functions
[**worker_get_connectors_list**](DefaultApi.md#worker_get_connectors_list) | **GET** /worker/connectors | Fetches a list of supported Pulsar IO connectors currently running in cluster mode
[**worker_get_drain_status**](DefaultApi.md#worker_get_drain_status) | **GET** /worker/drain | Get the status of any ongoing drain operation at this worker
[**worker_get_drain_status_from_leader**](DefaultApi.md#worker_get_drain_status_from_leader) | **GET** /worker/leader/drain | Get the status of any ongoing drain operation at the specified worker
[**worker_is_leader_ready**](DefaultApi.md#worker_is_leader_ready) | **GET** /worker/cluster/leader/ready | Checks if this node is the leader and is ready to service requests
[**worker_rebalance**](DefaultApi.md#worker_rebalance) | **PUT** /worker/rebalance | Triggers a rebalance of functions to workers
[**worker_stats_get_metrics**](DefaultApi.md#worker_stats_get_metrics) | **GET** /worker-stats/metrics | Gets the metrics for Monitoring
[**worker_stats_get_stats**](DefaultApi.md#worker_stats_get_stats) | **GET** /worker-stats/functionsmetrics | Get metrics for all functions owned by worker



## worker_drain

> worker_drain()
Drains this worker, i.e., moves its work-assignments to other workers

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_drain_at_leader

> worker_drain_at_leader(worker_id)
Drains the specified worker, i.e., moves its work-assignments to other workers

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**worker_id** | Option<**String**> |  |  |

### Return type

 (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_get_assignments

> std::collections::HashMap<String, serde_json::Value> worker_get_assignments()
Fetches information about which Pulsar Functions are assigned to which Pulsar clusters

### Parameters

This endpoint does not need any parameter.

### Return type

[**std::collections::HashMap<String, serde_json::Value>**](serde_json::Value.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_get_cluster

> Vec<models::WorkerInfo> worker_get_cluster()
Fetches information about the Pulsar cluster running Pulsar Functions

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::WorkerInfo>**](WorkerInfo.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_get_cluster_leader

> models::WorkerInfo worker_get_cluster_leader()
Fetches info about the leader node of the Pulsar cluster running Pulsar Functions

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::WorkerInfo**](WorkerInfo.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_get_connectors_list

> Vec<serde_json::Value> worker_get_connectors_list()
Fetches a list of supported Pulsar IO connectors currently running in cluster mode

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<serde_json::Value>**](serde_json::Value.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_get_drain_status

> models::LongRunningProcessStatus worker_get_drain_status()
Get the status of any ongoing drain operation at this worker

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::LongRunningProcessStatus**](LongRunningProcessStatus.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_get_drain_status_from_leader

> models::LongRunningProcessStatus worker_get_drain_status_from_leader(worker_id)
Get the status of any ongoing drain operation at the specified worker

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**worker_id** | Option<**String**> |  |  |

### Return type

[**models::LongRunningProcessStatus**](LongRunningProcessStatus.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_is_leader_ready

> bool worker_is_leader_ready()
Checks if this node is the leader and is ready to service requests

### Parameters

This endpoint does not need any parameter.

### Return type

**bool**

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: */*

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_rebalance

> worker_rebalance()
Triggers a rebalance of functions to workers

### Parameters

This endpoint does not need any parameter.

### Return type

 (empty response body)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_stats_get_metrics

> Vec<models::Metrics> worker_stats_get_metrics()
Gets the metrics for Monitoring

Request should be executed by Monitoring agent on each worker to fetch the worker-metrics

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::Metrics>**](Metrics.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## worker_stats_get_stats

> Vec<models::WorkerFunctionInstanceStats> worker_stats_get_stats()
Get metrics for all functions owned by worker

Requested should be executed by Monitoring agent on each worker to fetch the metrics

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::WorkerFunctionInstanceStats>**](WorkerFunctionInstanceStats.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)