/
Functions.java
323 lines (302 loc) · 9.96 KB
/
Functions.java
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
/**
* 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.
*/
package org.apache.pulsar.client.admin;
import java.util.List;
import java.util.Set;
import org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException;
import org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException;
import org.apache.pulsar.client.admin.PulsarAdminException.PreconditionFailedException;
import org.apache.pulsar.common.io.ConnectorDefinition;
import org.apache.pulsar.functions.proto.Function.FunctionDetails;
import org.apache.pulsar.functions.proto.InstanceCommunication.FunctionStatusList;
import org.apache.pulsar.functions.proto.InstanceCommunication.Metrics;
import org.apache.pulsar.functions.worker.WorkerInfo;
/**
* Admin interface for function management.
*/
public interface Functions {
/**
* Get the list of functions.
* <p>
* Get the list of all the Pulsar functions.
* <p>
* Response Example:
*
* <pre>
* <code>["f1", "f2", "f3"]</code>
* </pre>
*
* @throws NotAuthorizedException
* Don't have admin permission
* @throws PulsarAdminException
* Unexpected error
*/
List<String> getFunctions(String tenant, String namespace) throws PulsarAdminException;
/**
* Get the configuration for the specified function.
* <p>
* Response Example:
*
* <pre>
* <code>{ serviceUrl : "http://my-broker.example.com:8080/" }</code>
* </pre>
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @return the function configuration
*
* @throws NotAuthorizedException
* You don't have admin permission to get the configuration of the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
FunctionDetails getFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Create a new function.
*
* @param functionDetails
* the function configuration object
*
* @throws PulsarAdminException
* Unexpected error
*/
void createFunction(FunctionDetails functionDetails, String fileName) throws PulsarAdminException;
/**
* <pre>
* Create a new function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
* </pre>
*
* @param functionDetails
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
* @throws PulsarAdminException
*/
void createFunctionWithUrl(FunctionDetails functionDetails, String pkgUrl) throws PulsarAdminException;
/**
* Update the configuration for a function.
* <p>
*
* @param functionDetails
* the function configuration object
*
* @throws NotAuthorizedException
* You don't have admin permission to create the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateFunction(FunctionDetails functionDetails, String fileName) throws PulsarAdminException;
/**
* Update the configuration for a function.
* <pre>
* Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file
* eg:
* File: file:/dir/fileName.jar
* Http: http://www.repo.com/fileName.jar
* </pre>
*
* @param functionDetails
* the function configuration object
* @param pkgUrl
* url from which pkg can be downloaded
* @throws NotAuthorizedException
* You don't have admin permission to create the cluster
* @throws NotFoundException
* Cluster doesn't exist
* @throws PulsarAdminException
* Unexpected error
*/
void updateFunctionWithUrl(FunctionDetails functionDetails, String pkgUrl) throws PulsarAdminException;
/**
* Delete an existing function
* <p>
* Delete a function
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws NotAuthorizedException
* You don't have admin permission
* @throws NotFoundException
* Cluster does not exist
* @throws PreconditionFailedException
* Cluster is not empty
* @throws PulsarAdminException
* Unexpected error
*/
void deleteFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Gets the current status of a function.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws PulsarAdminException
* Unexpected error
*/
FunctionStatusList getFunctionStatus(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Restart function instance
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*
* @throws PulsarAdminException
* Unexpected error
*/
void restartFunction(String tenant, String namespace, String function, int instanceId) throws PulsarAdminException;
/**
* Restart all function instances
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws PulsarAdminException
* Unexpected error
*/
void restartFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Stop function instance
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @param instanceId
* Function instanceId
*
* @throws PulsarAdminException
* Unexpected error
*/
void stopFunction(String tenant, String namespace, String function, int instanceId) throws PulsarAdminException;
/**
* Stop all function instances
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
*
* @throws PulsarAdminException
* Unexpected error
*/
void stopFunction(String tenant, String namespace, String function) throws PulsarAdminException;
/**
* Triggers the function by writing to the input topic.
*
* @param tenant
* Tenant name
* @param namespace
* Namespace name
* @param function
* Function name
* @param triggerValue
* The input that will be written to input topic
* @param triggerFile
* The file which contains the input that will be written to input topic
*
* @throws PulsarAdminException
* Unexpected error
*/
String triggerFunction(String tenant, String namespace, String function, String topic, String triggerValue, String triggerFile) throws PulsarAdminException;
/**
* Upload Data.
*
* @param sourceFile
* dataFile that needs to be uploaded
* @param path
* Path where data should be stored
*
* @throws PulsarAdminException
* Unexpected error
*/
void uploadFunction(String sourceFile, String path) throws PulsarAdminException;
/**
* Download Function Code.
*
* @param destinationFile
* file where data should be downloaded to
* @param path
* Path where data is located
*
* @throws PulsarAdminException
* Unexpected error
*/
void downloadFunction(String destinationFile, String path) throws PulsarAdminException;
/**
* Fetches a list of supported Pulsar IO connectors currently running in cluster mode
*
* @throws PulsarAdminException
* Unexpected error
*
*/
List<ConnectorDefinition> getConnectorsList() throws PulsarAdminException;
/**
* Fetches a list of supported Pulsar IO sources currently running in cluster mode
*
* @throws PulsarAdminException
* Unexpected error
*
*/
Set<String> getSources() throws PulsarAdminException;
/**
* Fetches a list of supported Pulsar IO sinks currently running in cluster mode
*
* @throws PulsarAdminException
* Unexpected error
*
*/
Set<String> getSinks() throws PulsarAdminException;
}