org.apache.pulsar.broker.admin.v2

Class Functions

java.lang.Object

org.apache.pulsar.broker.web.PulsarWebResource

org.apache.pulsar.broker.admin.AdminResource

org.apache.pulsar.broker.admin.v2.Functions

Direct Known Subclasses:

Functions

@Path(value="/functions")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public class Functions
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
Functions()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deregisterFunction(String tenant, String namespace, String functionName)
javax.ws.rs.core.Response	downloadFunction(String path)
List<org.apache.pulsar.common.io.ConnectorDefinition>	getConnectorsList()
javax.ws.rs.core.Response	getFunctionInfo(String tenant, String namespace, String functionName)
javax.ws.rs.core.Response	getFunctionInstanceStatus(String tenant, String namespace, String functionName, String instanceId)
javax.ws.rs.core.Response	getFunctionState(String tenant, String namespace, String functionName, String key)
javax.ws.rs.core.Response	getFunctionStatus(String tenant, String namespace, String functionName)
javax.ws.rs.core.Response	listFunctions(String tenant, String namespace)
javax.ws.rs.core.Response	registerFunction(String tenant, String namespace, String functionName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String functionPkgUrl, String functionDetailsJson)
javax.ws.rs.core.Response	restartFunction(String tenant, String namespace, String functionName)
javax.ws.rs.core.Response	restartFunction(String tenant, String namespace, String functionName, String instanceId)
javax.ws.rs.core.Response	stopFunction(String tenant, String namespace, String functionName)
javax.ws.rs.core.Response	stopFunction(String tenant, String namespace, String functionName, String instanceId)
javax.ws.rs.core.Response	triggerFunction(String tenant, String namespace, String functionName, String triggerValue, InputStream triggerStream, String topic)
javax.ws.rs.core.Response	updateFunction(String tenant, String namespace, String functionName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String functionPkgUrl, String functionDetailsJson)
javax.ws.rs.core.Response	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

Functions

public Functions()

Method Detail

registerFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}")
 @Consumes(value="multipart/form-data")
public javax.ws.rs.core.Response 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,
                                                                                                                                                     String functionDetailsJson)

updateFunction

@PUT
 @Path(value="/{tenant}/{namespace}/{functionName}")
 @Consumes(value="multipart/form-data")
public javax.ws.rs.core.Response 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,
                                                                                                                                                  String functionDetailsJson)

deregisterFunction

@DELETE
 @Path(value="/{tenant}/{namespace}/{functionName}")
public javax.ws.rs.core.Response deregisterFunction(@PathParam(value="tenant")
                                                                                                                 String tenant,
                                                                                                                 @PathParam(value="namespace")
                                                                                                                 String namespace,
                                                                                                                 @PathParam(value="functionName")
                                                                                                                 String functionName)

getFunctionInfo

@GET
 @Path(value="/{tenant}/{namespace}/{functionName}")
public javax.ws.rs.core.Response getFunctionInfo(@PathParam(value="tenant")
                                                                                                           String tenant,
                                                                                                           @PathParam(value="namespace")
                                                                                                           String namespace,
                                                                                                           @PathParam(value="functionName")
                                                                                                           String functionName)
                                                                                                    throws IOException

Throws:

IOException

getFunctionInstanceStatus

@GET
 @Path(value="/{tenant}/{namespace}/{functionName}/{instanceId}/status")
public javax.ws.rs.core.Response 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
 @Path(value="/{tenant}/{namespace}/{functionName}/status")
public javax.ws.rs.core.Response getFunctionStatus(@PathParam(value="tenant")
                                                                                                                    String tenant,
                                                                                                                    @PathParam(value="namespace")
                                                                                                                    String namespace,
                                                                                                                    @PathParam(value="functionName")
                                                                                                                    String functionName)
                                                                                                             throws IOException

Throws:

IOException

listFunctions

@GET
 @Path(value="/{tenant}/{namespace}")
public javax.ws.rs.core.Response 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 javax.ws.rs.core.Response 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 javax.ws.rs.core.Response getFunctionState(@PathParam(value="tenant")
                                                                                                                        String tenant,
                                                                                                                        @PathParam(value="namespace")
                                                                                                                        String namespace,
                                                                                                                        @PathParam(value="functionName")
                                                                                                                        String functionName,
                                                                                                                        @PathParam(value="key")
                                                                                                                        String key)

restartFunction

@POST
 @Path(value="/{tenant}/{namespace}/{functionName}/{instanceId}/restart")
 @Consumes(value="application/json")
public javax.ws.rs.core.Response 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 javax.ws.rs.core.Response 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 javax.ws.rs.core.Response 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 javax.ws.rs.core.Response stopFunction(@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 javax.ws.rs.core.Response uploadFunction(InputStream uploadedInputStream,
                                                                                                                      String path)

downloadFunction

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

getConnectorsList

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

Throws:

IOException