Package org.apache.pulsar.functions.worker.service.api

Interface Functions<W extends WorkerService>

All Superinterfaces:

Component<W>

All Known Implementing Classes:

FunctionsImpl

public interface Functions<W extends WorkerService>
extends Component<W>

The service to manage functions.

Method Summary

Modifier and Type	Method	Description
List<org.apache.pulsar.common.functions.FunctionDefinition>	getBuiltinFunctions(AuthenticationParameters authParams)
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData	getFunctionInstanceStatus(String tenant, String namespace, String componentName, String instanceId, URI uri, AuthenticationParameters authParams)
org.apache.pulsar.common.policies.data.FunctionStatus	getFunctionStatus(String tenant, String namespace, String componentName, URI uri, AuthenticationParameters authParams)
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, AuthenticationParameters authParams)	Register a new function.
void	reloadBuiltinFunctions(AuthenticationParameters authParams)
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, AuthenticationParameters authParams, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)	Update a function.
void	updateFunctionOnWorkerLeader(String tenant, String namespace, String functionName, InputStream uploadedInputStream, boolean delete, URI uri, AuthenticationParameters authParams)

Methods inherited from interface org.apache.pulsar.functions.worker.service.api.Component

deregisterFunction, downloadFunction, downloadFunction, getFunctionInfo, getFunctionsInstanceStats, getFunctionState, getFunctionStats, getListOfConnectors, listFunctions, putFunctionState, reloadConnectors, restartFunctionInstance, restartFunctionInstances, startFunctionInstance, startFunctionInstances, stopFunctionInstance, stopFunctionInstances, triggerFunction, uploadFunction, worker

Method Details

registerFunction

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,
 AuthenticationParameters authParams)

Register a new function.

Parameters:

tenant - The tenant of a Pulsar Function

namespace - The namespace of a Pulsar Function

functionName - The name of a Pulsar Function

uploadedInputStream - Input stream of bytes

fileDetail - A form-data content disposition header

functionPkgUrl - URL path of the Pulsar Function package

functionConfig - Configuration of Pulsar Function

authParams - the authentication parameters associated with the request

updateFunction

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,
 AuthenticationParameters authParams,
 org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

Update a function.

Parameters:

tenant - The tenant of a Pulsar Function

namespace - The namespace of a Pulsar Function

functionName - The name of a Pulsar Function

uploadedInputStream - Input stream of bytes

fileDetail - A form-data content disposition header

functionPkgUrl - URL path of the Pulsar Function package

functionConfig - Configuration of Pulsar Function

authParams - the authentication parameters associated with the request

updateOptions - Options while updating the function

updateFunctionOnWorkerLeader

void updateFunctionOnWorkerLeader(String tenant,
 String namespace,
 String functionName,
 InputStream uploadedInputStream,
 boolean delete,
 URI uri,
 AuthenticationParameters authParams)

getFunctionStatus

org.apache.pulsar.common.policies.data.FunctionStatus getFunctionStatus(String tenant,
 String namespace,
 String componentName,
 URI uri,
 AuthenticationParameters authParams)

getFunctionInstanceStatus

org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData getFunctionInstanceStatus(String tenant,
 String namespace,
 String componentName,
 String instanceId,
 URI uri,
 AuthenticationParameters authParams)

reloadBuiltinFunctions

void reloadBuiltinFunctions(AuthenticationParameters authParams)
                     throws IOException

Throws:

IOException

getBuiltinFunctions

List<org.apache.pulsar.common.functions.FunctionDefinition> getBuiltinFunctions(AuthenticationParameters authParams)