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 and Description
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData	getFunctionInstanceStatus(String tenant, String namespace, String componentName, String instanceId, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
org.apache.pulsar.common.policies.data.FunctionStatus	getFunctionStatus(String tenant, String namespace, String componentName, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
default 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, String clientRole, AuthenticationDataHttps clientAuthenticationDataHttps) Deprecated.
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, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps) Register a new function.
default 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, String clientRole, AuthenticationDataHttps clientAuthenticationDataHttps, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions) Deprecated.
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, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions) Update a function.
void	updateFunctionOnWorkerLeader(String tenant, String namespace, String functionName, InputStream uploadedInputStream, boolean delete, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)

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

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

Method Detail

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,
                      String clientRole,
                      AuthenticationDataSource clientAuthenticationDataHttps)

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

clientRole - Client role for running the pulsar function

clientAuthenticationDataHttps - Authentication status of the http client

registerFunction

@Deprecated
default 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,
                                          String clientRole,
                                          AuthenticationDataHttps clientAuthenticationDataHttps)

Deprecated.

This method uses an incorrect signature 'AuthenticationDataHttps' that prevents the extension of auth status, so it is marked as deprecated and kept here only for backward compatibility. Please use the method that accepts the signature of the AuthenticationDataSource.

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,
                    String clientRole,
                    AuthenticationDataSource clientAuthenticationDataHttps,
                    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

clientRole - Client role for running the Pulsar Function

clientAuthenticationDataHttps - Authentication status of the http client

updateOptions - Options while updating the function

updateFunction

@Deprecated
default 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,
                                        String clientRole,
                                        AuthenticationDataHttps clientAuthenticationDataHttps,
                                        org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

Deprecated.

This method uses an incorrect signature 'AuthenticationDataHttps' that prevents the extension of auth status, so it is marked as deprecated and kept here only for backward compatibility. Please use the method that accepts the signature of the AuthenticationDataSource.

updateFunctionOnWorkerLeader

void updateFunctionOnWorkerLeader(String tenant,
                                  String namespace,
                                  String functionName,
                                  InputStream uploadedInputStream,
                                  boolean delete,
                                  URI uri,
                                  String clientRole,
                                  AuthenticationDataSource clientAuthenticationDataHttps)

getFunctionStatus

org.apache.pulsar.common.policies.data.FunctionStatus getFunctionStatus(String tenant,
                                                                        String namespace,
                                                                        String componentName,
                                                                        URI uri,
                                                                        String clientRole,
                                                                        AuthenticationDataSource clientAuthenticationDataHttps)

getFunctionInstanceStatus

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