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

Class FunctionsImpl

java.lang.Object

org.apache.pulsar.functions.worker.rest.api.ComponentImpl

org.apache.pulsar.functions.worker.rest.api.FunctionsImpl

All Implemented Interfaces:

Component<PulsarWorkerService>, Functions<PulsarWorkerService>

public class FunctionsImpl
extends ComponentImpl
implements Functions<PulsarWorkerService>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.pulsar.functions.worker.rest.api.ComponentImpl

ComponentImpl.GetStatus<S,T>

Field Summary

Fields inherited from class org.apache.pulsar.functions.worker.rest.api.ComponentImpl

componentType, workerServiceSupplier

Constructor Summary

Constructors

Constructor	Description
FunctionsImpl(java.util.function.Supplier<PulsarWorkerService> workerServiceSupplier)

Method Summary

Modifier and Type	Method	Description
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData	getFunctionInstanceStatus(java.lang.String tenant, java.lang.String namespace, java.lang.String componentName, java.lang.String instanceId, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)	Get status of a function instance.
org.apache.pulsar.common.policies.data.FunctionStatus	getFunctionStatus(java.lang.String tenant, java.lang.String namespace, java.lang.String componentName, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)	Get statuses of all function instances.
void	registerFunction(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String functionPkgUrl, org.apache.pulsar.common.functions.FunctionConfig functionConfig, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)	Register a new function.
void	updateFunction(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String functionPkgUrl, org.apache.pulsar.common.functions.FunctionConfig functionConfig, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)	Update a function.
void	updateFunctionOnWorkerLeader(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.io.InputStream uploadedInputStream, boolean delete, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

Methods inherited from class org.apache.pulsar.functions.worker.rest.api.ComponentImpl

allowFunctionOps, allowFunctionOps, changeFunctionInstanceStatus, changeFunctionInstanceStatus, changeFunctionStatusAllInstances, changeFunctionStatusAllInstances, componentInstanceStatusRequestValidate, componentInstanceStatusRequestValidate, componentStatusRequestValidate, componentStatusRequestValidate, createPackagePath, deregisterFunction, downloadFunction, downloadFunction, getClassLoaderFromPackage, getFunctionInfo, getFunctionsInstanceStats, getFunctionState, getFunctionStats, getListOfConnectors, isAuthorizedRole, isAuthorizedRole, isSuperUser, isSuperUser, listFunctions, putFunctionState, reloadConnectors, restartFunctionInstance, restartFunctionInstances, startFunctionInstance, startFunctionInstances, stopFunctionInstance, stopFunctionInstances, throwRestExceptionIfUnauthorizedForNamespace, triggerFunction, uploadFunction, validateGetFunctionInstanceRequestParams, validateGetFunctionRequestParams, worker

Methods inherited from class java.lang.Object

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

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

Constructor Detail

FunctionsImpl

public FunctionsImpl(java.util.function.Supplier<PulsarWorkerService> workerServiceSupplier)

Method Detail

registerFunction

public void registerFunction(java.lang.String tenant,
                             java.lang.String namespace,
                             java.lang.String functionName,
                             java.io.InputStream uploadedInputStream,
                             org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                             java.lang.String functionPkgUrl,
                             org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                             org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

Description copied from interface: Functions

Register a new function.

Specified by:

registerFunction in interface Functions<PulsarWorkerService>

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

public void updateFunction(java.lang.String tenant,
                           java.lang.String namespace,
                           java.lang.String functionName,
                           java.io.InputStream uploadedInputStream,
                           org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                           java.lang.String functionPkgUrl,
                           org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                           org.apache.pulsar.broker.authentication.AuthenticationParameters authParams,
                           org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

Description copied from interface: Functions

Update a function.

Specified by:

updateFunction in interface Functions<PulsarWorkerService>

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

getFunctionInstanceStatus

public org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData getFunctionInstanceStatus(java.lang.String tenant,
                                                                                                                                         java.lang.String namespace,
                                                                                                                                         java.lang.String componentName,
                                                                                                                                         java.lang.String instanceId,
                                                                                                                                         java.net.URI uri,
                                                                                                                                         org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

Get status of a function instance. If this worker is not running the function instance,

Specified by:

getFunctionInstanceStatus in interface Functions<PulsarWorkerService>

Parameters:

tenant - the tenant the function belongs to

namespace - the namespace the function belongs to

componentName - the function name

instanceId - the function instance id

Returns:

the function status

getFunctionStatus

public org.apache.pulsar.common.policies.data.FunctionStatus getFunctionStatus(java.lang.String tenant,
                                                                               java.lang.String namespace,
                                                                               java.lang.String componentName,
                                                                               java.net.URI uri,
                                                                               org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

Get statuses of all function instances.

Specified by:

getFunctionStatus in interface Functions<PulsarWorkerService>

Parameters:

tenant - the tenant the function belongs to

namespace - the namespace the function belongs to

componentName - the function name

Returns:

a list of function statuses

Throws:

org.apache.pulsar.client.admin.PulsarAdminException

updateFunctionOnWorkerLeader

public void updateFunctionOnWorkerLeader(java.lang.String tenant,
                                         java.lang.String namespace,
                                         java.lang.String functionName,
                                         java.io.InputStream uploadedInputStream,
                                         boolean delete,
                                         java.net.URI uri,
                                         org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

Specified by:

updateFunctionOnWorkerLeader in interface Functions<PulsarWorkerService>