FunctionsImpl (Pulsar Client Admin Original 2.7.2.2-rc-202105210936 API)

java.lang.Object
- org.apache.pulsar.client.admin.internal.BaseResource
- - org.apache.pulsar.client.admin.internal.ComponentResource
  - - org.apache.pulsar.client.admin.internal.FunctionsImpl

All Implemented Interfaces:: Functions

public class FunctionsImpl
extends ComponentResource
implements Functions

Field Summary
- Fields inherited from class org.apache.pulsar.client.admin.internal.BaseResource
  auth, readTimeoutMs

Constructor Summary

Constructors
Constructor and Description
`FunctionsImpl(javax.ws.rs.client.WebTarget web, org.apache.pulsar.client.api.Authentication auth, org.asynchttpclient.AsyncHttpClient asyncHttpClient, long readTimeoutMs)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createFunction(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String fileName)` Create a new function.
`CompletableFuture<Void>`	`createFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String fileName)` Create a new function asynchronously.
`void`	`createFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String pkgUrl)` Create a new function with package url.
`CompletableFuture<Void>`	`createFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String pkgUrl)` Create a new function with package url asynchronously.
`void`	`deleteFunction(String cluster, String namespace, String function)` Delete an existing function.
`CompletableFuture<Void>`	`deleteFunctionAsync(String tenant, String namespace, String function)` Delete an existing function asynchronously.
`void`	`downloadFunction(String destinationPath, String path)` Download Function Code.
`void`	`downloadFunction(String destinationPath, String tenant, String namespace, String functionName)` Download Function Code.
`CompletableFuture<Void>`	`downloadFunctionAsync(String destinationFile, String path)` Download Function Code.
`CompletableFuture<Void>`	`downloadFunctionAsync(String destinationPath, String tenant, String namespace, String functionName)` Download Function Code asynchronously.
`List<org.apache.pulsar.common.functions.WorkerInfo>`	`getCluster()`
`List<org.apache.pulsar.common.io.ConnectorDefinition>`	`getConnectorsList()` Deprecated in favor of getting sources and sinks for their own APIs.
`org.apache.pulsar.common.functions.FunctionConfig`	`getFunction(String tenant, String namespace, String function)` Get the configuration for the specified function.
`CompletableFuture<org.apache.pulsar.common.functions.FunctionConfig>`	`getFunctionAsync(String tenant, String namespace, String function)` Get the configuration for the specified function asynchronously.
`List<String>`	`getFunctions(String tenant, String namespace)` Get the list of functions.
`CompletableFuture<List<String>>`	`getFunctionsAsync(String tenant, String namespace)` Get the list of functions asynchronously.
`org.apache.pulsar.common.functions.FunctionState`	`getFunctionState(String tenant, String namespace, String function, String key)` Fetch the current state associated with a Pulsar Function.
`CompletableFuture<org.apache.pulsar.common.functions.FunctionState>`	`getFunctionStateAsync(String tenant, String namespace, String function, String key)` Fetch the current state associated with a Pulsar Function asynchronously.
`org.apache.pulsar.common.policies.data.FunctionStats`	`getFunctionStats(String tenant, String namespace, String function)` Gets the current stats of a function.
`org.apache.pulsar.common.policies.data.FunctionStats.FunctionInstanceStats.FunctionInstanceStatsData`	`getFunctionStats(String tenant, String namespace, String function, int id)` Gets the current stats of a function instance.
`CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStats>`	`getFunctionStatsAsync(String tenant, String namespace, String function)` Gets the current stats of a function asynchronously.
`CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStats.FunctionInstanceStats.FunctionInstanceStatsData>`	`getFunctionStatsAsync(String tenant, String namespace, String function, int id)` Gets the current stats of a function instance asynchronously.
`org.apache.pulsar.common.policies.data.FunctionStatus`	`getFunctionStatus(String tenant, String namespace, String function)` Gets the current status of a function.
`org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData`	`getFunctionStatus(String tenant, String namespace, String function, int id)` Gets the current status of a function instance.
`CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStatus>`	`getFunctionStatusAsync(String tenant, String namespace, String function)` Gets the current status of a function asynchronously.
`CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData>`	`getFunctionStatusAsync(String tenant, String namespace, String function, int id)` Gets the current status of a function instance asynchronously.
`Set<String>`	`getSinks()` Deprecated in favor of getting sources and sinks for their own APIs.
`Set<String>`	`getSources()` Deprecated in favor of getting sources and sinks for their own APIs.
`void`	`putFunctionState(String tenant, String namespace, String function, org.apache.pulsar.common.functions.FunctionState state)` Puts the given state associated with a Pulsar Function.
`CompletableFuture<Void>`	`putFunctionStateAsync(String tenant, String namespace, String function, org.apache.pulsar.common.functions.FunctionState state)` Puts the given state associated with a Pulsar Function asynchronously.
`void`	`restartFunction(String tenant, String namespace, String functionName)` Restart all function instances.
`void`	`restartFunction(String tenant, String namespace, String functionName, int instanceId)` Restart function instance.
`CompletableFuture<Void>`	`restartFunctionAsync(String tenant, String namespace, String function)` Restart all function instances asynchronously.
`CompletableFuture<Void>`	`restartFunctionAsync(String tenant, String namespace, String function, int instanceId)` Restart function instance asynchronously.
`void`	`startFunction(String tenant, String namespace, String functionName)` Start all function instances.
`void`	`startFunction(String tenant, String namespace, String functionName, int instanceId)` Start function instance.
`CompletableFuture<Void>`	`startFunctionAsync(String tenant, String namespace, String function)` Start all function instances asynchronously.
`CompletableFuture<Void>`	`startFunctionAsync(String tenant, String namespace, String function, int instanceId)` Start function instance asynchronously.
`void`	`stopFunction(String tenant, String namespace, String functionName)` Stop all function instances.
`void`	`stopFunction(String tenant, String namespace, String functionName, int instanceId)` Stop function instance.
`CompletableFuture<Void>`	`stopFunctionAsync(String tenant, String namespace, String function)` Stop all function instances asynchronously.
`CompletableFuture<Void>`	`stopFunctionAsync(String tenant, String namespace, String function, int instanceId)` Stop function instance asynchronously.
`String`	`triggerFunction(String tenant, String namespace, String functionName, String topic, String triggerValue, String triggerFile)` Triggers the function by writing to the input topic.
`CompletableFuture<String>`	`triggerFunctionAsync(String tenant, String namespace, String function, String topic, String triggerValue, String triggerFile)` Triggers the function by writing to the input topic asynchronously.
`void`	`updateFunction(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String fileName)` Update the configuration for a function.
`void`	`updateFunction(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String fileName, org.apache.pulsar.common.functions.UpdateOptions updateOptions)` Update the configuration for a function.
`CompletableFuture<Void>`	`updateFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String fileName)` Update the configuration for a function asynchronously.
`CompletableFuture<Void>`	`updateFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String fileName, org.apache.pulsar.common.functions.UpdateOptions updateOptions)` Update the configuration for a function asynchronously.
`void`	`updateFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String pkgUrl)` Update the configuration for a function.
`void`	`updateFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String pkgUrl, org.apache.pulsar.common.functions.UpdateOptions updateOptions)` Update the configuration for a function.
`CompletableFuture<Void>`	`updateFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String pkgUrl)` Update the configuration for a function asynchronously.
`CompletableFuture<Void>`	`updateFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig, String pkgUrl, org.apache.pulsar.common.functions.UpdateOptions updateOptions)` Update the configuration for a function asynchronously.
`void`	`updateOnWorkerLeader(String tenant, String namespace, String function, byte[] functionMetaData, boolean delete)`
`CompletableFuture<Void>`	`updateOnWorkerLeaderAsync(String tenant, String namespace, String function, byte[] functionMetaData, boolean delete)`
`void`	`uploadFunction(String sourceFile, String path)` Upload Data.
`CompletableFuture<Void>`	`uploadFunctionAsync(String sourceFile, String path)` Upload Data asynchronously.

Methods inherited from class org.apache.pulsar.client.admin.internal.ComponentResource
addAuthHeaders

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource
asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, getApiException, request, requestAsync

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,
                     org.apache.pulsar.client.api.Authentication auth,
                     org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                     long readTimeoutMs)

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

getFunctionsAsync

public CompletableFuture<List<String>> getFunctionsAsync(String tenant,
                                                         String namespace)

Description copied from interface: Functions

Get the list of functions asynchronously.

Get the list of all the Pulsar functions.

Response Example:

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

Specified by:: getFunctionsAsync in interface Functions

getFunction

public org.apache.pulsar.common.functions.FunctionConfig 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

getFunctionAsync

public CompletableFuture<org.apache.pulsar.common.functions.FunctionConfig> getFunctionAsync(String tenant,
                                                                                             String namespace,
                                                                                             String function)

Description copied from interface: Functions

Get the configuration for the specified function asynchronously.

Response Example:

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

Specified by:: getFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name
Returns:: the function configuration

getFunctionStatus

public org.apache.pulsar.common.policies.data.FunctionStatus 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

getFunctionStatusAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStatus> getFunctionStatusAsync(String tenant,
                                                                                                       String namespace,
                                                                                                       String function)

Description copied from interface: Functions

Gets the current status of a function asynchronously.

Specified by:: getFunctionStatusAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name

getFunctionStatus

public org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData getFunctionStatus(String tenant,
                                                                                                                                 String namespace,
                                                                                                                                 String function,
                                                                                                                                 int id)
                                                                                                                          throws PulsarAdminException

Description copied from interface: Functions

Gets the current status of a function instance.

Specified by:: getFunctionStatus in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; id - Function instance-id
Returns:
Throws:: PulsarAdminException

getFunctionStatusAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData> getFunctionStatusAsync(String tenant,
                                                                                                                                                         String namespace,
                                                                                                                                                         String function,
                                                                                                                                                         int id)

Description copied from interface: Functions

Gets the current status of a function instance asynchronously.

Specified by:: getFunctionStatusAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; id - Function instance-id
Returns:

getFunctionStats

public org.apache.pulsar.common.policies.data.FunctionStats.FunctionInstanceStats.FunctionInstanceStatsData getFunctionStats(String tenant,
                                                                                                                             String namespace,
                                                                                                                             String function,
                                                                                                                             int id)
                                                                                                                      throws PulsarAdminException

Description copied from interface: Functions

Gets the current stats of a function instance.

Specified by:: getFunctionStats in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; id - Function instance-id
Returns:
Throws:: PulsarAdminException

getFunctionStatsAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStats.FunctionInstanceStats.FunctionInstanceStatsData> getFunctionStatsAsync(String tenant,
                                                                                                                                                     String namespace,
                                                                                                                                                     String function,
                                                                                                                                                     int id)

Description copied from interface: Functions

Gets the current stats of a function instance asynchronously.

Specified by:: getFunctionStatsAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; id - Function instance-id
Returns:

getFunctionStats

public org.apache.pulsar.common.policies.data.FunctionStats getFunctionStats(String tenant,
                                                                             String namespace,
                                                                             String function)
                                                                      throws PulsarAdminException

Description copied from interface: Functions

Gets the current stats of a function.

Specified by:: getFunctionStats in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name
Returns:
Throws:: PulsarAdminException

getFunctionStatsAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.FunctionStats> getFunctionStatsAsync(String tenant,
                                                                                                     String namespace,
                                                                                                     String function)

Description copied from interface: Functions

Gets the current stats of a function asynchronously.

Specified by:: getFunctionStatsAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name
Returns:

createFunction
```
public void createFunction(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                           String fileName)
                    throws PulsarAdminException
```
Description copied from interface: Functions

Create a new function.

Specified by:

createFunction in interface Functions

Parameters:

functionConfig - the function configuration object

Throws:

PulsarAdminException - Unexpected error

createFunctionAsync

public CompletableFuture<Void> createFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                                   String fileName)

Description copied from interface: Functions

Create a new function asynchronously.

Specified by:: createFunctionAsync in interface Functions
Parameters:: functionConfig - the function configuration object

createFunctionWithUrl
```
public void createFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                  String pkgUrl)
                           throws PulsarAdminException
```
Description copied from interface: Functions

Create a new function with package url.
Create a new function by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

createFunctionWithUrl in interface Functions

Parameters:

functionConfig - the function configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

PulsarAdminException

createFunctionWithUrlAsync
```
public CompletableFuture<Void> createFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                                          String pkgUrl)
```
Description copied from interface: Functions

Create a new function with package url asynchronously.
Create a new function by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

createFunctionWithUrlAsync in interface Functions

Parameters:

functionConfig - the function configuration object

pkgUrl - url from which pkg can be downloaded

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

deleteFunctionAsync

public CompletableFuture<Void> deleteFunctionAsync(String tenant,
                                                   String namespace,
                                                   String function)

Description copied from interface: Functions

Delete an existing function asynchronously.

Delete a function

Specified by:: deleteFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name

updateFunction
```
public void updateFunction(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                           String fileName)
                    throws PulsarAdminException
```
Description copied from interface: Functions

Update the configuration for a function.

Specified by:

updateFunction in interface Functions

Parameters:

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

updateFunctionAsync

public CompletableFuture<Void> updateFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                                   String fileName)

Description copied from interface: Functions

Update the configuration for a function asynchronously.

Specified by:: updateFunctionAsync in interface Functions
Parameters:: functionConfig - the function configuration object

updateFunction
```
public void updateFunction(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                           String fileName,
                           org.apache.pulsar.common.functions.UpdateOptions updateOptions)
                    throws PulsarAdminException
```
Description copied from interface: Functions

Update the configuration for a function.

Specified by:

updateFunction in interface Functions

Parameters:

functionConfig - the function configuration object

updateOptions - options for the update operations

Throws:

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

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateFunctionAsync

public CompletableFuture<Void> updateFunctionAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                                   String fileName,
                                                   org.apache.pulsar.common.functions.UpdateOptions updateOptions)

Description copied from interface: Functions

Update the configuration for a function asynchronously.

Specified by:: updateFunctionAsync in interface Functions
Parameters:: functionConfig - the function configuration object; updateOptions - options for the update operations

updateFunctionWithUrl
```
public void updateFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                  String pkgUrl,
                                  org.apache.pulsar.common.functions.UpdateOptions updateOptions)
                           throws PulsarAdminException
```
Description copied from interface: Functions

Update the configuration for a function.
Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateFunctionWithUrl in interface Functions

Parameters:

functionConfig - the function configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

Throws:

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

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateFunctionWithUrlAsync
```
public CompletableFuture<Void> updateFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                                          String pkgUrl,
                                                          org.apache.pulsar.common.functions.UpdateOptions updateOptions)
```
Description copied from interface: Functions

Update the configuration for a function asynchronously.
Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateFunctionWithUrlAsync in interface Functions

Parameters:

functionConfig - the function configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

updateFunctionWithUrl
```
public void updateFunctionWithUrl(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                  String pkgUrl)
                           throws PulsarAdminException
```
Description copied from interface: Functions

Update the configuration for a function.
Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateFunctionWithUrl in interface Functions

Parameters:

functionConfig - the function configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

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

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateFunctionWithUrlAsync
```
public CompletableFuture<Void> updateFunctionWithUrlAsync(org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                                          String pkgUrl)
```
Description copied from interface: Functions

Update the configuration for a function asynchronously.
Update a function by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Specified by:

updateFunctionWithUrlAsync in interface Functions

Parameters:

functionConfig - the function configuration object

pkgUrl - url from which pkg can be downloaded

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

triggerFunctionAsync

public CompletableFuture<String> triggerFunctionAsync(String tenant,
                                                      String namespace,
                                                      String function,
                                                      String topic,
                                                      String triggerValue,
                                                      String triggerFile)

Description copied from interface: Functions

Triggers the function by writing to the input topic asynchronously.

Specified by:: triggerFunctionAsync in interface Functions
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

restartFunction

public void restartFunction(String tenant,
                            String namespace,
                            String functionName,
                            int instanceId)
                     throws PulsarAdminException

Description copied from interface: Functions

Restart function instance.

Specified by:: restartFunction in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; functionName - Function name; instanceId - Function instanceId
Throws:: PulsarAdminException - Unexpected error

restartFunctionAsync

public CompletableFuture<Void> restartFunctionAsync(String tenant,
                                                    String namespace,
                                                    String function,
                                                    int instanceId)

Description copied from interface: Functions

Restart function instance asynchronously.

Specified by:: restartFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; instanceId - Function instanceId

restartFunction
```
public void restartFunction(String tenant,
                            String namespace,
                            String functionName)
                     throws PulsarAdminException
```
Description copied from interface: Functions

Restart all function instances.

Specified by:

restartFunction in interface Functions

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Function name

Throws:

PulsarAdminException - Unexpected error

restartFunctionAsync

public CompletableFuture<Void> restartFunctionAsync(String tenant,
                                                    String namespace,
                                                    String function)

Description copied from interface: Functions

Restart all function instances asynchronously.

Specified by:: restartFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name

stopFunction
```
public void stopFunction(String tenant,
                         String namespace,
                         String functionName,
                         int instanceId)
                  throws PulsarAdminException
```
Description copied from interface: Functions

Stop function instance.

Specified by:

stopFunction in interface Functions

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Function name

instanceId - Function instanceId

Throws:

PulsarAdminException - Unexpected error

stopFunctionAsync

public CompletableFuture<Void> stopFunctionAsync(String tenant,
                                                 String namespace,
                                                 String function,
                                                 int instanceId)

Description copied from interface: Functions

Stop function instance asynchronously.

Specified by:: stopFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; instanceId - Function instanceId

stopFunction
```
public void stopFunction(String tenant,
                         String namespace,
                         String functionName)
                  throws PulsarAdminException
```
Description copied from interface: Functions

Stop all function instances.

Specified by:

stopFunction in interface Functions

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Function name

Throws:

PulsarAdminException - Unexpected error

stopFunctionAsync

public CompletableFuture<Void> stopFunctionAsync(String tenant,
                                                 String namespace,
                                                 String function)

Description copied from interface: Functions

Stop all function instances asynchronously.

Specified by:: stopFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name

startFunction

public void startFunction(String tenant,
                          String namespace,
                          String functionName,
                          int instanceId)
                   throws PulsarAdminException

Description copied from interface: Functions

Start function instance.

Specified by:: startFunction in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; functionName - Function name; instanceId - Function instanceId
Throws:: PulsarAdminException - Unexpected error

startFunctionAsync

public CompletableFuture<Void> startFunctionAsync(String tenant,
                                                  String namespace,
                                                  String function,
                                                  int instanceId)

Description copied from interface: Functions

Start function instance asynchronously.

Specified by:: startFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; instanceId - Function instanceId

startFunction
```
public void startFunction(String tenant,
                          String namespace,
                          String functionName)
                   throws PulsarAdminException
```
Description copied from interface: Functions

Start all function instances.

Specified by:

startFunction in interface Functions

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Function name

Throws:

PulsarAdminException - Unexpected error

startFunctionAsync

public CompletableFuture<Void> startFunctionAsync(String tenant,
                                                  String namespace,
                                                  String function)

Description copied from interface: Functions

Start all function instances asynchronously.

Specified by:: startFunctionAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name

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

uploadFunctionAsync
```
public CompletableFuture<Void> uploadFunctionAsync(String sourceFile,
                                                   String path)
```
Description copied from interface: Functions

Upload Data asynchronously.

Specified by:

uploadFunctionAsync in interface Functions

Parameters:

sourceFile - dataFile that needs to be uploaded

path - Path where data should be stored

downloadFunction

public void downloadFunction(String destinationPath,
                             String tenant,
                             String namespace,
                             String functionName)
                      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; tenant - Tenant name; namespace - Namespace name; functionName - Function name
Throws:: PulsarAdminException

downloadFunctionAsync

public CompletableFuture<Void> downloadFunctionAsync(String destinationPath,
                                                     String tenant,
                                                     String namespace,
                                                     String functionName)

Description copied from interface: Functions

Download Function Code asynchronously.

Specified by:: downloadFunctionAsync in interface Functions
Parameters:: destinationPath - file where data should be downloaded to; tenant - Tenant name; namespace - Namespace name; functionName - Function name

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

downloadFunctionAsync
```
public CompletableFuture<Void> downloadFunctionAsync(String destinationFile,
                                                     String path)
```
Description copied from interface: Functions

Download Function Code.

Specified by:

downloadFunctionAsync in interface Functions

Parameters:

destinationFile - file where data should be downloaded to

path - Path where data is located

getConnectorsList
```
public List<org.apache.pulsar.common.io.ConnectorDefinition> getConnectorsList()
                                                                        throws PulsarAdminException
```
Description copied from interface: Functions

Deprecated in favor of getting sources and sinks for their own APIs.
Fetches a list of supported Pulsar IO connectors currently running in cluster mode

Specified by:

getConnectorsList in interface Functions

Throws:

PulsarAdminException - Unexpected error

getSources
```
public Set<String> getSources()
                       throws PulsarAdminException
```
Description copied from interface: Functions

Deprecated in favor of getting sources and sinks for their own APIs.
Fetches a list of supported Pulsar IO sources currently running in cluster mode

Specified by:

getSources in interface Functions

Throws:

PulsarAdminException - Unexpected error

getSinks
```
public Set<String> getSinks()
                     throws PulsarAdminException
```
Description copied from interface: Functions

Deprecated in favor of getting sources and sinks for their own APIs.
Fetches a list of supported Pulsar IO sinks currently running in cluster mode

Specified by:

getSinks in interface Functions

Throws:

PulsarAdminException - Unexpected error

getCluster

public List<org.apache.pulsar.common.functions.WorkerInfo> getCluster()
                                                               throws PulsarAdminException

Throws:: PulsarAdminException

getFunctionState

public org.apache.pulsar.common.functions.FunctionState getFunctionState(String tenant,
                                                                         String namespace,
                                                                         String function,
                                                                         String key)
                                                                  throws PulsarAdminException

Description copied from interface: Functions

Fetch the current state associated with a Pulsar Function.

Response Example:

 { "value : 12, version : 2"}

Specified by:: getFunctionState in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; key - Key name of State
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

getFunctionStateAsync

public CompletableFuture<org.apache.pulsar.common.functions.FunctionState> getFunctionStateAsync(String tenant,
                                                                                                 String namespace,
                                                                                                 String function,
                                                                                                 String key)

Description copied from interface: Functions

Fetch the current state associated with a Pulsar Function asynchronously.

Response Example:

 { "value : 12, version : 2"}

Specified by:: getFunctionStateAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; key - Key name of State
Returns:: the function configuration

putFunctionState
```
public void putFunctionState(String tenant,
                             String namespace,
                             String function,
                             org.apache.pulsar.common.functions.FunctionState state)
                      throws PulsarAdminException
```
Description copied from interface: Functions
Puts the given state associated with a Pulsar Function.
Response Example:
```
 { "value : 12, version : 2"}
 
```
Specified by:

putFunctionState in interface Functions

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Function name

state - FunctionState

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

putFunctionStateAsync

public CompletableFuture<Void> putFunctionStateAsync(String tenant,
                                                     String namespace,
                                                     String function,
                                                     org.apache.pulsar.common.functions.FunctionState state)

Description copied from interface: Functions

Puts the given state associated with a Pulsar Function asynchronously.

Response Example:

 { "value : 12, version : 2"}

Specified by:: putFunctionStateAsync in interface Functions
Parameters:: tenant - Tenant name; namespace - Namespace name; function - Function name; state - FunctionState

updateOnWorkerLeader

public void updateOnWorkerLeader(String tenant,
                                 String namespace,
                                 String function,
                                 byte[] functionMetaData,
                                 boolean delete)
                          throws PulsarAdminException

Throws:: PulsarAdminException

updateOnWorkerLeaderAsync

public CompletableFuture<Void> updateOnWorkerLeaderAsync(String tenant,
                                                         String namespace,
                                                         String function,
                                                         byte[] functionMetaData,
                                                         boolean delete)

Class FunctionsImpl

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

FunctionsImpl

Method Detail

getFunctions

getFunctionsAsync

getFunction

getFunctionAsync

getFunctionStatus

getFunctionStatusAsync

getFunctionStatus

getFunctionStatusAsync

getFunctionStats

getFunctionStatsAsync

getFunctionStats

getFunctionStatsAsync

createFunction

createFunctionAsync

createFunctionWithUrl

createFunctionWithUrlAsync

deleteFunction

deleteFunctionAsync

updateFunction

updateFunctionAsync

updateFunction

updateFunctionAsync

updateFunctionWithUrl

updateFunctionWithUrlAsync

updateFunctionWithUrl

updateFunctionWithUrlAsync

triggerFunction

triggerFunctionAsync

restartFunction

restartFunctionAsync

restartFunction

restartFunctionAsync

stopFunction

stopFunctionAsync

stopFunction

stopFunctionAsync

startFunction

startFunctionAsync

startFunction

startFunctionAsync

uploadFunction

uploadFunctionAsync

downloadFunction

downloadFunctionAsync

downloadFunction

downloadFunctionAsync

getConnectorsList

getSources

getSinks

getCluster

getFunctionState

getFunctionStateAsync

putFunctionState

putFunctionStateAsync

updateOnWorkerLeader

updateOnWorkerLeaderAsync