Package org.apache.pulsar.functions.worker.service.api

Interface FunctionsV2<W extends WorkerService>

  • All Known Implementing Classes:
    FunctionsImplV2
    public interface FunctionsV2<W extends WorkerService>
    The v2 functions API to manage functions.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response deregisterFunction​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response downloadFunction​(java.lang.String path, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response getFunctionInfo​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response getFunctionInstanceStatus​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.lang.String instanceId, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response getFunctionState​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.lang.String key, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response getFunctionStatusV2​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.net.URI requestUri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      java.util.List<org.apache.pulsar.common.io.ConnectorDefinition> getListOfConnectors()  
      javax.ws.rs.core.Response listFunctions​(java.lang.String tenant, java.lang.String namespace, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response registerFunction​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String functionPkgUrl, java.lang.String functionDetailsJson, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response restartFunctionInstance​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.lang.String instanceId, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response restartFunctionInstances​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response stopFunctionInstance​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.lang.String instanceId, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response stopFunctionInstances​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response triggerFunction​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.lang.String triggerValue, java.io.InputStream triggerStream, java.lang.String topic, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response updateFunction​(java.lang.String tenant, java.lang.String namespace, java.lang.String functionName, java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String functionPkgUrl, java.lang.String functionDetailsJson, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  
      javax.ws.rs.core.Response uploadFunction​(java.io.InputStream uploadedInputStream, java.lang.String path, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)  

    • Method Detail

      • getFunctionInfo

        javax.ws.rs.core.Response getFunctionInfo​(java.lang.String tenant,
                                          java.lang.String namespace,
                                          java.lang.String functionName,
                                          org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • getFunctionInstanceStatus

        javax.ws.rs.core.Response getFunctionInstanceStatus​(java.lang.String tenant,
                                                    java.lang.String namespace,
                                                    java.lang.String functionName,
                                                    java.lang.String instanceId,
                                                    java.net.URI uri,
                                                    org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • getFunctionStatusV2

        javax.ws.rs.core.Response getFunctionStatusV2​(java.lang.String tenant,
                                              java.lang.String namespace,
                                              java.lang.String functionName,
                                              java.net.URI requestUri,
                                              org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • registerFunction

        javax.ws.rs.core.Response registerFunction​(java.lang.String tenant,
                                           java.lang.String namespace,
                                           java.lang.String functionName,
                                           java.io.InputStream uploadedInputStream,
                                           org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                           java.lang.String functionPkgUrl,
                                           java.lang.String functionDetailsJson,
                                           org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • updateFunction

        javax.ws.rs.core.Response updateFunction​(java.lang.String tenant,
                                         java.lang.String namespace,
                                         java.lang.String functionName,
                                         java.io.InputStream uploadedInputStream,
                                         org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                         java.lang.String functionPkgUrl,
                                         java.lang.String functionDetailsJson,
                                         org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • deregisterFunction

        javax.ws.rs.core.Response deregisterFunction​(java.lang.String tenant,
                                             java.lang.String namespace,
                                             java.lang.String functionName,
                                             org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • listFunctions

        javax.ws.rs.core.Response listFunctions​(java.lang.String tenant,
                                        java.lang.String namespace,
                                        org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • triggerFunction

        javax.ws.rs.core.Response triggerFunction​(java.lang.String tenant,
                                          java.lang.String namespace,
                                          java.lang.String functionName,
                                          java.lang.String triggerValue,
                                          java.io.InputStream triggerStream,
                                          java.lang.String topic,
                                          org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • getFunctionState

        javax.ws.rs.core.Response getFunctionState​(java.lang.String tenant,
                                           java.lang.String namespace,
                                           java.lang.String functionName,
                                           java.lang.String key,
                                           org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • restartFunctionInstance

        javax.ws.rs.core.Response restartFunctionInstance​(java.lang.String tenant,
                                                  java.lang.String namespace,
                                                  java.lang.String functionName,
                                                  java.lang.String instanceId,
                                                  java.net.URI uri,
                                                  org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • restartFunctionInstances

        javax.ws.rs.core.Response restartFunctionInstances​(java.lang.String tenant,
                                                   java.lang.String namespace,
                                                   java.lang.String functionName,
                                                   org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • stopFunctionInstance

        javax.ws.rs.core.Response stopFunctionInstance​(java.lang.String tenant,
                                               java.lang.String namespace,
                                               java.lang.String functionName,
                                               java.lang.String instanceId,
                                               java.net.URI uri,
                                               org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • stopFunctionInstances

        javax.ws.rs.core.Response stopFunctionInstances​(java.lang.String tenant,
                                                java.lang.String namespace,
                                                java.lang.String functionName,
                                                org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • uploadFunction

        javax.ws.rs.core.Response uploadFunction​(java.io.InputStream uploadedInputStream,
                                         java.lang.String path,
                                         org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • downloadFunction

        javax.ws.rs.core.Response downloadFunction​(java.lang.String path,
                                           org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

      • getListOfConnectors

        java.util.List<org.apache.pulsar.common.io.ConnectorDefinition> getListOfConnectors()