Package 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	Description
java.util.List<org.apache.pulsar.common.io.ConfigFieldDefinition>	getSinkConfigDefinition(java.lang.String name)
org.apache.pulsar.common.io.SinkConfig	getSinkInfo(java.lang.String tenant, java.lang.String namespace, java.lang.String componentName, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData	getSinkInstanceStatus(java.lang.String tenant, java.lang.String namespace, java.lang.String sinkName, java.lang.String instanceId, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)
java.util.List<org.apache.pulsar.common.io.ConnectorDefinition>	getSinkList()
org.apache.pulsar.common.policies.data.SinkStatus	getSinkStatus(java.lang.String tenant, java.lang.String namespace, java.lang.String componentName, java.net.URI uri, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)
void	registerSink(java.lang.String tenant, java.lang.String namespace, java.lang.String sinkName, java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)	Update a function.
void	updateSink(java.lang.String tenant, java.lang.String namespace, java.lang.String sinkName, java.io.InputStream uploadedInputStream, org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail, java.lang.String sinkPkgUrl, org.apache.pulsar.common.io.SinkConfig sinkConfig, org.apache.pulsar.broker.authentication.AuthenticationParameters authParams, org.apache.pulsar.common.functions.UpdateOptionsImpl updateOptions)	Update a function.

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

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

Method Detail

registerSink

void registerSink(java.lang.String tenant,
                  java.lang.String namespace,
                  java.lang.String sinkName,
                  java.io.InputStream uploadedInputStream,
                  org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                  java.lang.String sinkPkgUrl,
                  org.apache.pulsar.common.io.SinkConfig sinkConfig,
                  org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

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

authParams - the authentication parameters associated with the request

updateSink

void updateSink(java.lang.String tenant,
                java.lang.String namespace,
                java.lang.String sinkName,
                java.io.InputStream uploadedInputStream,
                org.glassfish.jersey.media.multipart.FormDataContentDisposition fileDetail,
                java.lang.String sinkPkgUrl,
                org.apache.pulsar.common.io.SinkConfig sinkConfig,
                org.apache.pulsar.broker.authentication.AuthenticationParameters authParams,
                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

authParams - the authentication parameters associated with the request

updateOptions - Options while updating the sink

getSinkInstanceStatus

org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData getSinkInstanceStatus(java.lang.String tenant,
                                                                                                                  java.lang.String namespace,
                                                                                                                  java.lang.String sinkName,
                                                                                                                  java.lang.String instanceId,
                                                                                                                  java.net.URI uri,
                                                                                                                  org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

getSinkStatus

org.apache.pulsar.common.policies.data.SinkStatus getSinkStatus(java.lang.String tenant,
                                                                java.lang.String namespace,
                                                                java.lang.String componentName,
                                                                java.net.URI uri,
                                                                org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

getSinkInfo

org.apache.pulsar.common.io.SinkConfig getSinkInfo(java.lang.String tenant,
                                                   java.lang.String namespace,
                                                   java.lang.String componentName,
                                                   org.apache.pulsar.broker.authentication.AuthenticationParameters authParams)

getSinkList

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

getSinkConfigDefinition

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