org.apache.pulsar.client.admin

Interface Functions

All Known Implementing Classes:

FunctionsImpl

public interface Functions

Admin interface for function management.

Method Summary

Modifier and Type	Method and Description
void	createFunction(org.apache.pulsar.functions.shaded.proto.Function.FunctionDetails functionDetails, String fileName) Create a new function.
void	deleteFunction(String tenant, String namespace, String function) Delete an existing function
void	downloadFunction(String destinationFile, String path) Download Function Code.
org.apache.pulsar.functions.shaded.proto.Function.FunctionDetails	getFunction(String tenant, String namespace, String function) Get the configuration for the specified function.
List<String>	getFunctions(String tenant, String namespace) Get the list of functions.
org.apache.pulsar.functions.shaded.proto.InstanceCommunication.FunctionStatusList	getFunctionStatus(String tenant, String namespace, String function) Gets the current status of a function.
String	triggerFunction(String tenant, String namespace, String function, String topic, String triggerValue, String triggerFile) Triggers the function by writing to the input topic.
void	updateFunction(org.apache.pulsar.functions.shaded.proto.Function.FunctionDetails functionDetails, String fileName) Update the configuration for a function.
void	uploadFunction(String sourceFile, String path) Upload Data.

Method Detail

getFunctions

List<String> getFunctions(String tenant,
                          String namespace)
                   throws PulsarAdminException

Get the list of functions.

Get the list of all the Pulsar functions.

Response Example:

 ["f1", "f2", "f3"]
 

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getFunction

org.apache.pulsar.functions.shaded.proto.Function.FunctionDetails getFunction(String tenant,
                                                                              String namespace,
                                                                              String function)
                                                                       throws PulsarAdminException

Get the configuration for the specified function.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Function name

Returns:

the function configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

createFunction

void createFunction(org.apache.pulsar.functions.shaded.proto.Function.FunctionDetails functionDetails,
                    String fileName)
             throws PulsarAdminException

Create a new function.

Parameters:

functionDetails - the function configuration object

Throws:

PulsarAdminException - Unexpected error

updateFunction

void updateFunction(org.apache.pulsar.functions.shaded.proto.Function.FunctionDetails functionDetails,
                    String fileName)
             throws PulsarAdminException

Update the configuration for a function.

Parameters:

functionDetails - the function configuration object

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

deleteFunction

void deleteFunction(String tenant,
                    String namespace,
                    String function)
             throws PulsarAdminException

Delete an existing function

Delete a function

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Function name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Cluster does not exist

PulsarAdminException.PreconditionFailedException - Cluster is not empty

PulsarAdminException - Unexpected error

getFunctionStatus

org.apache.pulsar.functions.shaded.proto.InstanceCommunication.FunctionStatusList getFunctionStatus(String tenant,
                                                                                                    String namespace,
                                                                                                    String function)
                                                                                             throws PulsarAdminException

Gets the current status of a function.

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Function name

Throws:

PulsarAdminException - Unexpected error

triggerFunction

String triggerFunction(String tenant,
                       String namespace,
                       String function,
                       String topic,
                       String triggerValue,
                       String triggerFile)
                throws PulsarAdminException

Triggers the function by writing to the input topic.

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Function name

triggerValue - The input that will be written to input topic

triggerFile - The file which contains the input that will be written to input topic

Throws:

PulsarAdminException - Unexpected error

uploadFunction

void uploadFunction(String sourceFile,
                    String path)
             throws PulsarAdminException

Upload Data.

Parameters:

sourceFile - dataFile that needs to be uploaded

path - Path where data should be stored

Throws:

PulsarAdminException - Unexpected error

downloadFunction

void downloadFunction(String destinationFile,
                      String path)
               throws PulsarAdminException

Download Function Code.

Parameters:

destinationFile - file where data should be downloaded to

path - Path where data is located

Throws:

PulsarAdminException - Unexpected error