org.apache.pulsar.client.admin.internal

Class FunctionsImpl

java.lang.Object

org.apache.pulsar.client.admin.internal.BaseResource

org.apache.pulsar.client.admin.internal.FunctionsImpl

All Implemented Interfaces:

Functions

public class FunctionsImpl
extends BaseResource
implements Functions

Constructor Summary

Constructors

Constructor and Description
FunctionsImpl(javax.ws.rs.client.WebTarget web, Authentication auth)

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 cluster, String namespace, String function) Delete an existing function
void	downloadFunction(String destinationPath, 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.
static void	mergeJson(String json, org.apache.pulsar.functions.shaded.com.google.protobuf.AbstractMessage.Builder builder)
static String	printJson(org.apache.pulsar.functions.shaded.com.google.protobuf.MessageOrBuilder msg)
String	triggerFunction(String tenant, String namespace, String functionName, 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.

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, request

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionsImpl

public FunctionsImpl(javax.ws.rs.client.WebTarget web,
                     Authentication auth)

Method Detail

getFunctions

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

Description copied from interface: Functions

Get the list of functions.

Get the list of all the Pulsar functions.

Response Example:

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

Specified by:

getFunctions in interface Functions

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getFunction

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

Description copied from interface: Functions

Get the configuration for the specified function.

Response Example:

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

Specified by:

getFunction in interface Functions

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

getFunctionStatus

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

Description copied from interface: Functions

Gets the current status of a function.

Specified by:

getFunctionStatus in interface Functions

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Function name

Throws:

PulsarAdminException - Unexpected error

createFunction

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

Description copied from interface: Functions

Create a new function.

Specified by:

createFunction in interface Functions

Parameters:

functionDetails - the function configuration object

Throws:

PulsarAdminException - Unexpected error

deleteFunction

public void deleteFunction(String cluster,
                           String namespace,
                           String function)
                    throws PulsarAdminException

Description copied from interface: Functions

Delete an existing function

Delete a function

Specified by:

deleteFunction in interface Functions

Parameters:

cluster - 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

updateFunction

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

Description copied from interface: Functions

Update the configuration for a function.

Specified by:

updateFunction in interface Functions

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

triggerFunction

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

Description copied from interface: Functions

Triggers the function by writing to the input topic.

Specified by:

triggerFunction in interface Functions

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - 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

public void uploadFunction(String sourceFile,
                           String path)
                    throws PulsarAdminException

Description copied from interface: Functions

Upload Data.

Specified by:

uploadFunction in interface Functions

Parameters:

sourceFile - dataFile that needs to be uploaded

path - Path where data should be stored

Throws:

PulsarAdminException - Unexpected error

downloadFunction

public void downloadFunction(String destinationPath,
                             String path)
                      throws PulsarAdminException

Description copied from interface: Functions

Download Function Code.

Specified by:

downloadFunction in interface Functions

Parameters:

destinationPath - file where data should be downloaded to

path - Path where data is located

Throws:

PulsarAdminException - Unexpected error

mergeJson

public static void mergeJson(String json,
                             org.apache.pulsar.functions.shaded.com.google.protobuf.AbstractMessage.Builder builder)
                      throws IOException

Throws:

IOException

printJson

public static String printJson(org.apache.pulsar.functions.shaded.com.google.protobuf.MessageOrBuilder msg)
                        throws IOException

Throws:

IOException