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

Interface Sinks<W extends WorkerService>

All Superinterfaces:

Component<W>

All Known Implementing Classes:

SinksImpl

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

The service to manage sinks.

Method Summary

Modifier and Type	Method and Description
List<org.apache.pulsar.common.io.ConfigFieldDefinition>	getSinkConfigDefinition(String name)
org.apache.pulsar.common.io.SinkConfig	getSinkInfo(String tenant, String namespace, String componentName)
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData	getSinkInstanceStatus(String tenant, String namespace, String sinkName, String instanceId, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
List<org.apache.pulsar.common.io.ConnectorDefinition>	getSinkList()
org.apache.pulsar.common.policies.data.SinkStatus	getSinkStatus(String tenant, String namespace, String componentName, URI uri, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps)
default void	registerSink(String tenant, String namespace, String sinkName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig, String clientRole, AuthenticationDataHttps clientAuthenticationDataHttps) Deprecated.
void	registerSink(String tenant, String namespace, String sinkName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig, String clientRole, AuthenticationDataSource clientAuthenticationDataHttps) Update a function.
default void	updateSink(String tenant, String namespace, String sinkName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig, String clientRole, AuthenticationDataHttps clientAuthenticationDataHttps, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions) Deprecated.
void	updateSink(String tenant, String namespace, String sinkName, InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig, 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

registerSink

void registerSink(String tenant,
                  String namespace,
                  String sinkName,
                  InputStream uploadedInputStream,
                  org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                  String sinkPkgUrl,
                  org.apache.pulsar.common.io.SinkConfig sinkConfig,
                  String clientRole,
                  AuthenticationDataSource clientAuthenticationDataHttps)

Update a function.

Parameters:

tenant - The tenant of a Pulsar Sink

namespace - The namespace of a Pulsar Sink

sinkName - The name of a Pulsar Sink

uploadedInputStream - Input stream of bytes

fileDetail - A form-data content disposition header

sinkPkgUrl - URL path of the Pulsar Sink package

sinkConfig - Configuration of Pulsar Sink

clientRole - Client role for running the Pulsar Sink

clientAuthenticationDataHttps - Authentication status of the http client

registerSink

@Deprecated
default void registerSink(String tenant,
                                      String namespace,
                                      String sinkName,
                                      InputStream uploadedInputStream,
                                      org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                      String sinkPkgUrl,
                                      org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                      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.

updateSink

void updateSink(String tenant,
                String namespace,
                String sinkName,
                InputStream uploadedInputStream,
                org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                String sinkPkgUrl,
                org.apache.pulsar.common.io.SinkConfig sinkConfig,
                String clientRole,
                AuthenticationDataSource clientAuthenticationDataHttps,
                org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)

Update a function.

Parameters:

tenant - The tenant of a Pulsar Sink

namespace - The namespace of a Pulsar Sink

sinkName - The name of a Pulsar Sink

uploadedInputStream - Input stream of bytes

fileDetail - A form-data content disposition header

sinkPkgUrl - URL path of the Pulsar Sink package

sinkConfig - Configuration of Pulsar Sink

clientRole - Client role for running the Pulsar Sink

clientAuthenticationDataHttps - Authentication status of the http client

updateOptions - Options while updating the sink

updateSink

@Deprecated
default void updateSink(String tenant,
                                    String namespace,
                                    String sinkName,
                                    InputStream uploadedInputStream,
                                    org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                                    String sinkPkgUrl,
                                    org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                    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.

getSinkInstanceStatus

org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData getSinkInstanceStatus(String tenant,
                                                                                                                  String namespace,
                                                                                                                  String sinkName,
                                                                                                                  String instanceId,
                                                                                                                  URI uri,
                                                                                                                  String clientRole,
                                                                                                                  AuthenticationDataSource clientAuthenticationDataHttps)

getSinkStatus

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

getSinkInfo

org.apache.pulsar.common.io.SinkConfig getSinkInfo(String tenant,
                                                   String namespace,
                                                   String componentName)

getSinkList

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

getSinkConfigDefinition

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