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

Interface Sources<W extends WorkerService>

All Superinterfaces:

Component<W>

All Known Implementing Classes:

SourcesImpl

public interface Sources<W extends WorkerService>
extends Component<W>

The service to manage sources.

Method Summary

Modifier and Type	Method and Description
List<org.apache.pulsar.common.io.ConfigFieldDefinition>	getSourceConfigDefinition(String name)
org.apache.pulsar.common.io.SourceConfig	getSourceInfo(String tenant, String namespace, String componentName)
org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData	getSourceInstanceStatus(String tenant, String namespace, String sourceName, String instanceId, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
List<org.apache.pulsar.common.io.ConnectorDefinition>	getSourceList()
org.apache.pulsar.common.policies.data.SourceStatus	getSourceStatus(String tenant, String namespace, String componentName, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
default void	registerSource(String tenant, String namespace, String sourceName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sourcePkgUrl, org.apache.pulsar.common.io.SourceConfig sourceConfig, String clientRole, AuthenticationDataHttps clientAuthenticationDataHttps) Deprecated.
void	registerSource(String tenant, String namespace, String sourceName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sourcePkgUrl, org.apache.pulsar.common.io.SourceConfig sourceConfig, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps) Update a function.
default void	updateSource(String tenant, String namespace, String sourceName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sourcePkgUrl, org.apache.pulsar.common.io.SourceConfig sourceConfig, String clientRole, AuthenticationDataHttps clientAuthenticationDataHttps, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions) Deprecated.
void	updateSource(String tenant, String namespace, String sourceName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sourcePkgUrl, org.apache.pulsar.common.io.SourceConfig sourceConfig, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions) Update a function.

Methods inherited from interface org.apache.pulsar.functions.worker.service.api.Component

deregisterFunction, deregisterFunction, downloadFunction, downloadFunction, downloadFunction, downloadFunction, getFunctionInfo, getFunctionsInstanceStats, getFunctionState, getFunctionStats, getListOfConnectors, listFunctions, putFunctionState, reloadConnectors, restartFunctionInstance, restartFunctionInstances, startFunctionInstance, startFunctionInstances, stopFunctionInstance, stopFunctionInstances, triggerFunction, uploadFunction, worker

Method Detail

registerSource

void registerSource(String tenant,
                    String namespace,
                    String sourceName,
                    InputStream uploadedInputStream,
                    org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                    String sourcePkgUrl,
                    org.apache.pulsar.common.io.SourceConfig sourceConfig,
                    String clientRole,
                    AuthenticationDataSource clientAuthenticationDataHttps)

Update a function.

Parameters:

tenant - The tenant of a Pulsar Source

namespace - The namespace of a Pulsar Source

sourceName - The name of a Pulsar Source

uploadedInputStream - Input stream of bytes

fileDetail - A form-data content disposition header

sourcePkgUrl - URL path of the Pulsar Source package

sourceConfig - Configuration of Pulsar Source

clientRole - Client role for running the Pulsar Source

clientAuthenticationDataHttps - Authentication status of the http client

registerSource

@Deprecated
default void registerSource(String tenant,
                                        String namespace,
                                        String sourceName,
                                        InputStream uploadedInputStream,
                                        org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                        String sourcePkgUrl,
                                        org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                        String clientRole,
                                        AuthenticationDataHttps clientAuthenticationDataHttps)

Deprecated.

This method uses an incorrect signature 'AuthenticationDataHttps' that prevents the extension of auth status, so it is marked as deprecated and kept here only for backward compatibility. Please use the method that accepts the signature of the AuthenticationDataSource.

updateSource

void updateSource(String tenant,
                  String namespace,
                  String sourceName,
                  InputStream uploadedInputStream,
                  org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                  String sourcePkgUrl,
                  org.apache.pulsar.common.io.SourceConfig sourceConfig,
                  String clientRole,
                  AuthenticationDataSource clientAuthenticationDataHttps,
                  org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

Update a function.

Parameters:

tenant - The tenant of a Pulsar Source

namespace - The namespace of a Pulsar Source

sourceName - The name of a Pulsar Source

uploadedInputStream - Input stream of bytes

fileDetail - A form-data content disposition header

sourcePkgUrl - URL path of the Pulsar Source package

sourceConfig - Configuration of Pulsar Source

clientRole - Client role for running the Pulsar Source

clientAuthenticationDataHttps - Authentication status of the http client

updateOptions - Options while updating the source

updateSource

@Deprecated
default void updateSource(String tenant,
                                      String namespace,
                                      String sourceName,
                                      InputStream uploadedInputStream,
                                      org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                      String sourcePkgUrl,
                                      org.apache.pulsar.common.io.SourceConfig sourceConfig,
                                      String clientRole,
                                      AuthenticationDataHttps clientAuthenticationDataHttps,
                                      org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

Deprecated.

This method uses an incorrect signature 'AuthenticationDataHttps' that prevents the extension of auth status, so it is marked as deprecated and kept here only for backward compatibility. Please use the method that accepts the signature of the AuthenticationDataSource.

getSourceStatus

org.apache.pulsar.common.policies.data.SourceStatus getSourceStatus(String tenant,
                                                                    String namespace,
                                                                    String componentName,
                                                                    URI uri,
                                                                    String clientRole,
                                                                    AuthenticationDataSource clientAuthenticationDataHttps)

getSourceInstanceStatus

org.apache.pulsar.common.policies.data.SourceStatus.SourceInstanceStatus.SourceInstanceStatusData getSourceInstanceStatus(String tenant,
                                                                                                                          String namespace,
                                                                                                                          String sourceName,
                                                                                                                          String instanceId,
                                                                                                                          URI uri,
                                                                                                                          String clientRole,
                                                                                                                          AuthenticationDataSource clientAuthenticationDataHttps)

getSourceInfo

org.apache.pulsar.common.io.SourceConfig getSourceInfo(String tenant,
                                                       String namespace,
                                                       String componentName)

getSourceList

List<org.apache.pulsar.common.io.ConnectorDefinition> getSourceList()

getSourceConfigDefinition

List<org.apache.pulsar.common.io.ConfigFieldDefinition> getSourceConfigDefinition(String name)