org.apache.pulsar.broker.admin.impl

Class FunctionsBase

java.lang.Object

org.apache.pulsar.broker.web.PulsarWebResource

org.apache.pulsar.broker.admin.AdminResource

org.apache.pulsar.broker.admin.impl.FunctionsBase

Direct Known Subclasses:

Functions

public class FunctionsBase
extends AdminResource

Field Summary

Fields inherited from class org.apache.pulsar.broker.admin.AdminResource

namespaceName, topicName

Fields inherited from class org.apache.pulsar.broker.web.PulsarWebResource

httpRequest, NOT_IMPLEMENTED, servletContext, uri

Constructor Summary

Constructors

Constructor and Description
FunctionsBase()

Method Summary

Modifier and Type	Method and Description
void	deregisterFunction(String tenant, String namespace, String functionName)
javax.ws.rs.core.StreamingOutput	downloadFunction(String path)
javax.ws.rs.core.StreamingOutput	downloadFunction(String tenant, String namespace, String functionName)
List<org.apache.pulsar.common.io.ConnectorDefinition>	getConnectorsList() Deprecated.
org.apache.pulsar.common.functions.FunctionConfig	getFunctionInfo(String tenant, String namespace, String functionName)
org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataImpl	getFunctionInstanceStats(String tenant, String namespace, String functionName, String instanceId)
org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData	getFunctionInstanceStatus(String tenant, String namespace, String functionName, String instanceId)
org.apache.pulsar.common.functions.FunctionState	getFunctionState(String tenant, String namespace, String functionName, String key)
org.apache.pulsar.common.policies.data.FunctionStatsImpl	getFunctionStats(String tenant, String namespace, String functionName)
org.apache.pulsar.common.policies.data.FunctionStatus	getFunctionStatus(String tenant, String namespace, String functionName)
List<String>	listFunctions(String tenant, String namespace)
void	putFunctionState(String tenant, String namespace, String functionName, String key, org.apache.pulsar.common.functions.FunctionState stateJson)
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)
void	restartFunction(String tenant, String namespace, String functionName)
void	restartFunction(String tenant, String namespace, String functionName, String instanceId)
void	startFunction(String tenant, String namespace, String functionName)
void	startFunction(String tenant, String namespace, String functionName, String instanceId)
void	stopFunction(String tenant, String namespace, String functionName)
void	stopFunction(String tenant, String namespace, String functionName, String instanceId)
String	triggerFunction(String tenant, String namespace, String functionName, String triggerValue, InputStream triggerStream, String topic)
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, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)
void	updateFunctionOnWorkerLeader(String tenant, String namespace, String functionName, InputStream uploadedInputStream, boolean delete)
void	uploadFunction(InputStream uploadedInputStream, String path)

Methods inherited from class org.apache.pulsar.broker.admin.AdminResource

bookKeeper, checkArgument, checkBacklogQuota, checkNotNull, checkNotNull, checkTopicExistsAsync, checkTopicLevelPolicyEnable, clusters, dispatchRate, domain, fetchPartitionedTopicMetadata, fetchPartitionedTopicMetadataCheckAllowAutoCreation, getNamespacePolicies, getNamespacePolicies, getNamespacePoliciesAsync, getNamespaceReplicatedClusters, getPartitionedTopicList, getPartitionedTopicMetadata, getPartitionedTopicMetadataAsync, getSchemaCompatibilityStrategyAsync, getTopicPartitionList, getTopicPoliciesAsyncWithRetry, internalCreatePartitionedTopic, isLeaderBroker, isManagedLedgerNotFoundException, isNamespaceReplicated, jsonMapper, mergeNamespaceWithDefaults, namespaceBacklogQuota, replicatorDispatchRate, resumeAsyncResponseExceptionally, setServletContext, subscribeRate, subscriptionDispatchRate, tryCreatePartitionsAsync, validateAdminAccessForTenant, validateBundleOwnership, validateClusterExists, validateGlobalNamespaceOwnership, validateNamespaceName, validateNamespaceName, validatePartitionedTopicMetadata, validatePartitionedTopicName, validatePersistencePolicies, validatePersistentTopicName, validatePersistentTopicName, validatePoliciesReadOnlyAccess, validateSuperUserAccess, validateTopicName, validateTopicName

Methods inherited from class org.apache.pulsar.broker.web.PulsarWebResource

bookieResources, canUpdateCluster, checkAuthorizationAsync, checkLocalOrGetPeerReplicationCluster, clientAppId, clientAuthData, clusterResources, config, dynamicConfigurationResources, getClusterDataIfDifferentCluster, getLocalPolicies, getPulsarResources, handleCommonRestAsyncException, hasActiveNamespace, hasSuperUserAccess, isBundleOwnedByAnyBroker, isClientAuthenticated, isLeaderBroker, isRequestHttps, namespaceIsolationPolicies, namespaceResources, originalPrincipal, pulsar, resourceGroupResources, setPulsar, splitPath, tenantResources, topicResources, validateAdminAccessForTenant, validateAdminAccessForTenantAsync, validateBrokerName, validateBundleOwnership, validateClusterForTenant, validateClusterOwnership, validateGlobalNamespaceOwnership, validateGlobalNamespaceOwnershipAsync, validateNamespaceBundleOwnership, validateNamespaceBundleRange, validateNamespaceOperation, validateNamespaceOperationAsync, validateNamespacePolicyOperation, validateTenantOperation, validateTopicOperation, validateTopicOperation, validateTopicOperationAsync, validateTopicOperationAsync, validateTopicOwnership, validateTopicOwnershipAsync, validateTopicPolicyOperation

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionsBase

public FunctionsBase()

Method Detail

registerFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}")
 @Consumes(value="multipart/form-data")
public void registerFunction(@PathParam(value="tenant")
                                                                                                                                String tenant,
                                                                                                                                @PathParam(value="namespace")
                                                                                                                                String namespace,
                                                                                                                                @PathParam(value="functionName")
                                                                                                                                String functionName,
                                                                                                                                InputStream uploadedInputStream,
                                                                                                                                org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                                                                                                                String functionPkgUrl,
                                                                                                                                org.apache.pulsar.common.functions.FunctionConfig functionConfig)

updateFunction

@PUT
 @Path(value="/{tenant}/{namespace}/{functionName}")
 @Consumes(value="multipart/form-data")
public void updateFunction(@PathParam(value="tenant")
                                                                                                                             String tenant,
                                                                                                                             @PathParam(value="namespace")
                                                                                                                             String namespace,
                                                                                                                             @PathParam(value="functionName")
                                                                                                                             String functionName,
                                                                                                                             InputStream uploadedInputStream,
                                                                                                                             org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                                                                                                             String functionPkgUrl,
                                                                                                                             org.apache.pulsar.common.functions.FunctionConfig functionConfig,
                                                                                                                             org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)
                                                                                                                      throws IOException

Throws:

IOException

deregisterFunction

@DELETE
 @Path(value="/{tenant}/{namespace}/{functionName}")
public void deregisterFunction(@PathParam(value="tenant")
                                                                                            String tenant,
                                                                                            @PathParam(value="namespace")
                                                                                            String namespace,
                                                                                            @PathParam(value="functionName")
                                                                                            String functionName)

getFunctionInfo

@GET
 @Path(value="/{tenant}/{namespace}/{functionName}")
public org.apache.pulsar.common.functions.FunctionConfig getFunctionInfo(@PathParam(value="tenant")
                                                                                                                                   String tenant,
                                                                                                                                   @PathParam(value="namespace")
                                                                                                                                   String namespace,
                                                                                                                                   @PathParam(value="functionName")
                                                                                                                                   String functionName)
                                                                                                                            throws IOException

Throws:

IOException

getFunctionInstanceStatus

@GET
 @Produces(value="application/json")
 @Path(value="/{tenant}/{namespace}/{functionName}/{instanceId}/status")
public org.apache.pulsar.common.policies.data.FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData getFunctionInstanceStatus(@PathParam(value="tenant")
                                                                                                                                                                                                                                                            String tenant,
                                                                                                                                                                                                                                                            @PathParam(value="namespace")
                                                                                                                                                                                                                                                            String namespace,
                                                                                                                                                                                                                                                            @PathParam(value="functionName")
                                                                                                                                                                                                                                                            String functionName,
                                                                                                                                                                                                                                                            @PathParam(value="instanceId")
                                                                                                                                                                                                                                                            String instanceId)
                                                                                                                                                                                                                                                     throws IOException

Throws:

IOException

getFunctionStatus

@GET
 @Produces(value="application/json")
 @Path(value="/{tenant}/{namespace}/{functionName}/status")
public org.apache.pulsar.common.policies.data.FunctionStatus getFunctionStatus(@PathParam(value="tenant")
                                                                                                                                                                                     String tenant,
                                                                                                                                                                                     @PathParam(value="namespace")
                                                                                                                                                                                     String namespace,
                                                                                                                                                                                     @PathParam(value="functionName")
                                                                                                                                                                                     String functionName)
                                                                                                                                                                              throws IOException

Throws:

IOException

getFunctionStats

@GET
 @Produces(value="application/json")
 @Path(value="/{tenant}/{namespace}/{functionName}/stats")
public org.apache.pulsar.common.policies.data.FunctionStatsImpl getFunctionStats(@PathParam(value="tenant")
                                                                                                                                                                                      String tenant,
                                                                                                                                                                                      @PathParam(value="namespace")
                                                                                                                                                                                      String namespace,
                                                                                                                                                                                      @PathParam(value="functionName")
                                                                                                                                                                                      String functionName)
                                                                                                                                                                               throws IOException

Throws:

IOException

getFunctionInstanceStats

@GET
 @Produces(value="application/json")
 @Path(value="/{tenant}/{namespace}/{functionName}/{instanceId}/stats")
public org.apache.pulsar.common.policies.data.FunctionInstanceStatsDataImpl getFunctionInstanceStats(@PathParam(value="tenant")
                                                                                                                                                                                                                       String tenant,
                                                                                                                                                                                                                       @PathParam(value="namespace")
                                                                                                                                                                                                                       String namespace,
                                                                                                                                                                                                                       @PathParam(value="functionName")
                                                                                                                                                                                                                       String functionName,
                                                                                                                                                                                                                       @PathParam(value="instanceId")
                                                                                                                                                                                                                       String instanceId)
                                                                                                                                                                                                                throws IOException

Throws:

IOException

listFunctions

@GET
 @Path(value="/{tenant}/{namespace}")
public List<String> listFunctions(@PathParam(value="tenant")
                                                                             String tenant,
                                                                             @PathParam(value="namespace")
                                                                             String namespace)

triggerFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/trigger")
 @Consumes(value="multipart/form-data")
public String triggerFunction(@PathParam(value="tenant")
                                                                                                                                         String tenant,
                                                                                                                                         @PathParam(value="namespace")
                                                                                                                                         String namespace,
                                                                                                                                         @PathParam(value="functionName")
                                                                                                                                         String functionName,
                                                                                                                                         String triggerValue,
                                                                                                                                         InputStream triggerStream,
                                                                                                                                         String topic)

getFunctionState

@GET
 @Path(value="/{tenant}/{namespace}/{functionName}/state/{key}")
public org.apache.pulsar.common.functions.FunctionState getFunctionState(@PathParam(value="tenant")
                                                                                                                                               String tenant,
                                                                                                                                               @PathParam(value="namespace")
                                                                                                                                               String namespace,
                                                                                                                                               @PathParam(value="functionName")
                                                                                                                                               String functionName,
                                                                                                                                               @PathParam(value="key")
                                                                                                                                               String key)

putFunctionState

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/state/{key}")
 @Consumes(value="multipart/form-data")
public void putFunctionState(@PathParam(value="tenant")
                                                                                                                                            String tenant,
                                                                                                                                            @PathParam(value="namespace")
                                                                                                                                            String namespace,
                                                                                                                                            @PathParam(value="functionName")
                                                                                                                                            String functionName,
                                                                                                                                            @PathParam(value="key")
                                                                                                                                            String key,
                                                                                                                                            org.apache.pulsar.common.functions.FunctionState stateJson)

restartFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/{instanceId}/restart")
 @Consumes(value="application/json")
public void restartFunction(@PathParam(value="tenant")
                                                                                                                                                 String tenant,
                                                                                                                                                 @PathParam(value="namespace")
                                                                                                                                                 String namespace,
                                                                                                                                                 @PathParam(value="functionName")
                                                                                                                                                 String functionName,
                                                                                                                                                 @PathParam(value="instanceId")
                                                                                                                                                 String instanceId)

restartFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/restart")
 @Consumes(value="application/json")
public void restartFunction(@PathParam(value="tenant")
                                                                                                                                    String tenant,
                                                                                                                                    @PathParam(value="namespace")
                                                                                                                                    String namespace,
                                                                                                                                    @PathParam(value="functionName")
                                                                                                                                    String functionName)

stopFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/{instanceId}/stop")
 @Consumes(value="application/json")
public void stopFunction(@PathParam(value="tenant")
                                                                                                                                           String tenant,
                                                                                                                                           @PathParam(value="namespace")
                                                                                                                                           String namespace,
                                                                                                                                           @PathParam(value="functionName")
                                                                                                                                           String functionName,
                                                                                                                                           @PathParam(value="instanceId")
                                                                                                                                           String instanceId)

stopFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/stop")
 @Consumes(value="application/json")
public void stopFunction(@PathParam(value="tenant")
                                                                                                                              String tenant,
                                                                                                                              @PathParam(value="namespace")
                                                                                                                              String namespace,
                                                                                                                              @PathParam(value="functionName")
                                                                                                                              String functionName)

startFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/{instanceId}/start")
 @Consumes(value="application/json")
public void startFunction(@PathParam(value="tenant")
                                                                                                                                             String tenant,
                                                                                                                                             @PathParam(value="namespace")
                                                                                                                                             String namespace,
                                                                                                                                             @PathParam(value="functionName")
                                                                                                                                             String functionName,
                                                                                                                                             @PathParam(value="instanceId")
                                                                                                                                             String instanceId)

startFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/start")
 @Consumes(value="application/json")
public void startFunction(@PathParam(value="tenant")
                                                                                                                                String tenant,
                                                                                                                                @PathParam(value="namespace")
                                                                                                                                String namespace,
                                                                                                                                @PathParam(value="functionName")
                                                                                                                                String functionName)

uploadFunction

@POST
 @Path(value="/upload")
 @Consumes(value="multipart/form-data")
public void uploadFunction(InputStream uploadedInputStream,
                                                                                                 String path)

downloadFunction

@GET
 @Path(value="/download")
public javax.ws.rs.core.StreamingOutput downloadFunction(@QueryParam(value="path")
                                                                                        String path)

downloadFunction

@GET
 @Path(value="/{tenant}/{namespace}/{functionName}/download")
public javax.ws.rs.core.StreamingOutput downloadFunction(@PathParam(value="tenant")
                                                                                                                            String tenant,
                                                                                                                            @PathParam(value="namespace")
                                                                                                                            String namespace,
                                                                                                                            @PathParam(value="functionName")
                                                                                                                            String functionName)

getConnectorsList

@GET
 @Path(value="/connectors")
 @Deprecated
public List<org.apache.pulsar.common.io.ConnectorDefinition> getConnectorsList()
                                                                                                                      throws IOException

Deprecated.

Throws:

IOException

updateFunctionOnWorkerLeader

@PUT
 @Path(value="/leader/{tenant}/{namespace}/{functionName}")
 @Consumes(value="multipart/form-data")
public void updateFunctionOnWorkerLeader(@PathParam(value="tenant")
                                                                                                                                                  String tenant,
                                                                                                                                                  @PathParam(value="namespace")
                                                                                                                                                  String namespace,
                                                                                                                                                  @PathParam(value="functionName")
                                                                                                                                                  String functionName,
                                                                                                                                                  InputStream uploadedInputStream,
                                                                                                                                                  boolean delete)