Package org.apache.pulsar.functions.worker.rest.api.v3

Class FunctionsApiV3Resource

java.lang.Object

org.apache.pulsar.functions.worker.rest.FunctionApiResource

org.apache.pulsar.functions.worker.rest.api.v3.FunctionsApiV3Resource

All Implemented Interfaces:

Supplier<WorkerService>

@Path("/functions")
@Produces("application/json")
@Consumes("application/json")
public class FunctionsApiV3Resource
extends FunctionApiResource

Field Summary

Fields inherited from class org.apache.pulsar.functions.worker.rest.FunctionApiResource

ATTRIBUTE_FUNCTION_WORKER, httpRequest, ORIGINAL_PRINCIPAL_HEADER, servletContext, uri

Constructor Summary

Constructors

Constructor	Description
FunctionsApiV3Resource()

Method Summary

Modifier and Type	Method	Description
void	deregisterFunction(String tenant, String namespace, String functionName)
javax.ws.rs.core.StreamingOutput	downloadFunction(String path)
javax.ws.rs.core.StreamingOutput	downloadFunction(String tenant, String namespace, String functionName, boolean transformFunction)
List<org.apache.pulsar.common.functions.FunctionDefinition>	getBuiltinFunctions()
List<org.apache.pulsar.common.io.ConnectorDefinition>	getConnectorsList()	Deprecated.
org.apache.pulsar.common.functions.FunctionConfig	getFunctionInfo(String tenant, String namespace, String functionName)
org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataImpl	getFunctionInstanceStats(String tenant, String namespace, String functionName, String instanceId)
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData	getFunctionInstanceStatus(String tenant, String namespace, String functionName, String instanceId)
org.apache.pulsar.common.functions.FunctionState	getFunctionState(String tenant, String namespace, String functionName, String key)
org.apache.pulsar.common.policies.data.FunctionStatsImpl	getFunctionStats(String tenant, String namespace, String functionName)
org.apache.pulsar.common.policies.data.FunctionStatus	getFunctionStatus(String tenant, String namespace, String functionName)
List<String>	listFunctions(String tenant, String namespace)
void	putFunctionState(String tenant, String namespace, String functionName, String key, org.apache.pulsar.common.functions.FunctionState stateJson)
void	registerFunction(String tenant, String namespace, String functionName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String functionPkgUrl, org.apache.pulsar.common.functions.FunctionConfig functionConfig)
void	reloadBuiltinFunctions()
void	restartFunction(String tenant, String namespace, String functionName)
void	restartFunction(String tenant, String namespace, String functionName, String instanceId)
void	startFunction(String tenant, String namespace, String functionName)
void	startFunction(String tenant, String namespace, String functionName, String instanceId)
void	stopFunction(String tenant, String namespace, String functionName)
void	stopFunction(String tenant, String namespace, String functionName, String instanceId)
String	triggerFunction(String tenant, String namespace, String functionName, String input, InputStream uploadedInputStream, String topic)
void	updateFunction(String tenant, String namespace, String functionName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String functionPkgUrl, org.apache.pulsar.common.functions.FunctionConfig functionConfig, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)
void	updateFunctionOnWorkerLeader(String tenant, String namespace, String functionName, InputStream uploadedInputStream, boolean delete)
void	uploadFunction(InputStream uploadedInputStream, String path)

Methods inherited from class org.apache.pulsar.functions.worker.rest.FunctionApiResource

authParams, clientAppId, clientAuthData, get

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FunctionsApiV3Resource

public FunctionsApiV3Resource()

Method Details

registerFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}")
@Consumes("multipart/form-data")
public void registerFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String functionPkgUrl,
 org.apache.pulsar.common.functions.FunctionConfig functionConfig)

updateFunction

@PUT
@Path("/{tenant}/{namespace}/{functionName}")
@Consumes("multipart/form-data")
public void updateFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 InputStream uploadedInputStream,
 org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
 String functionPkgUrl,
 org.apache.pulsar.common.functions.FunctionConfig functionConfig,
 org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

deregisterFunction

@DELETE
@Path("/{tenant}/{namespace}/{functionName}")
public void deregisterFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName)

getFunctionInfo

@GET
@Path("/{tenant}/{namespace}/{functionName}")
public org.apache.pulsar.common.functions.FunctionConfig getFunctionInfo(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName)

listFunctions

@GET
@Produces("application/json")
@Path("/{tenant}/{namespace}")
public List<String> listFunctions(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace)

getFunctionInstanceStatus

@GET
@Produces("application/json")
@Path("/{tenant}/{namespace}/{functionName}/{instanceId}/status")
public org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData getFunctionInstanceStatus(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @PathParam("instanceId")
 String instanceId)
                                                                                                                                  throws IOException

Throws:

IOException

getFunctionStatus

@GET
@Produces("application/json")
@Path("/{tenant}/{namespace}/{functionName}/status")
public org.apache.pulsar.common.policies.data.FunctionStatus getFunctionStatus(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName)
                                                                        throws IOException

Throws:

IOException

getFunctionStats

@GET
@Produces("application/json")
@Path("/{tenant}/{namespace}/{functionName}/stats")
public org.apache.pulsar.common.policies.data.FunctionStatsImpl getFunctionStats(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName)
                                                                          throws IOException

Throws:

IOException

getFunctionInstanceStats

@GET
@Produces("application/json")
@Path("/{tenant}/{namespace}/{functionName}/{instanceId}/stats")
public org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataImpl getFunctionInstanceStats(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @PathParam("instanceId")
 String instanceId)
                                                                                              throws IOException

Throws:

IOException

triggerFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}/trigger")
@Consumes("multipart/form-data")
public String triggerFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 String input,
 InputStream uploadedInputStream,
 String topic)

restartFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}/{instanceId}/restart")
@Consumes("application/json")
public void restartFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @PathParam("instanceId")
 String instanceId)

restartFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}/restart")
@Consumes("application/json")
public void restartFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName)

stopFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}/{instanceId}/stop")
@Consumes("application/json")
public void stopFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @PathParam("instanceId")
 String instanceId)

stopFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}/stop")
@Consumes("application/json")
public void stopFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName)

startFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}/{instanceId}/start")
@Consumes("application/json")
public void startFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @PathParam("instanceId")
 String instanceId)

startFunction

@POST
@Path("/{tenant}/{namespace}/{functionName}/start")
@Consumes("application/json")
public void startFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName)

uploadFunction

@POST
@Path("/upload")
@Consumes("multipart/form-data")
public void uploadFunction(InputStream uploadedInputStream,
 String path)

downloadFunction

@GET
@Path("/download")
public javax.ws.rs.core.StreamingOutput downloadFunction(@QueryParam("path")
 String path)

downloadFunction

@GET
@Path("/{tenant}/{namespace}/{functionName}/download")
public javax.ws.rs.core.StreamingOutput downloadFunction(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @QueryParam("transform-function")
 boolean transformFunction)

getConnectorsList

@GET
@Path("/connectors")
@Deprecated
public List<org.apache.pulsar.common.io.ConnectorDefinition> getConnectorsList()
                                                                        throws IOException

Deprecated.

Throws:

IOException

reloadBuiltinFunctions

@POST
@Path("/builtins/reload")
public void reloadBuiltinFunctions()
                            throws IOException

Throws:

IOException

getBuiltinFunctions

@GET
@Path("/builtins")
@Produces("application/json")
public List<org.apache.pulsar.common.functions.FunctionDefinition> getBuiltinFunctions()

getFunctionState

@GET
@Path("/{tenant}/{namespace}/{functionName}/state/{key}")
public org.apache.pulsar.common.functions.FunctionState getFunctionState(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @PathParam("key")
 String key)
                                                                  throws IOException

Throws:

IOException

putFunctionState

@POST
@Path("/{tenant}/{namespace}/{functionName}/state/{key}")
@Consumes("multipart/form-data")
public void putFunctionState(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 @PathParam("key")
 String key,
 org.apache.pulsar.common.functions.FunctionState stateJson)
                      throws IOException

Throws:

IOException

updateFunctionOnWorkerLeader

@PUT
@Path("/leader/{tenant}/{namespace}/{functionName}")
@Consumes("multipart/form-data")
public void updateFunctionOnWorkerLeader(@PathParam("tenant")
 String tenant,
 @PathParam("namespace")
 String namespace,
 @PathParam("functionName")
 String functionName,
 InputStream uploadedInputStream,
 boolean delete)