Package org.apache.pulsar.client.admin

Interface Sinks

All Known Subinterfaces:

Sink

public interface Sinks

Admin interface for Sink management.

Method Summary

Modifier and Type	Method	Description
void	createSink(SinkConfig sinkConfig, String fileName)	Create a new sink.
CompletableFuture<Void>	createSinkAsync(SinkConfig sinkConfig, String fileName)	Create a new sink asynchronously.
void	createSinkWithUrl(SinkConfig sinkConfig, String pkgUrl)	Create a new sink with package url.
CompletableFuture<Void>	createSinkWithUrlAsync(SinkConfig sinkConfig, String pkgUrl)	Create a new sink with package url asynchronously.
void	deleteSink(String tenant, String namespace, String sink)	Delete an existing sink.
CompletableFuture<Void>	deleteSinkAsync(String tenant, String namespace, String sink)	Delete an existing sink asynchronously.
List<ConnectorDefinition>	getBuiltInSinks()	Fetches a list of supported Pulsar IO sinks currently running in cluster mode.
CompletableFuture<List<ConnectorDefinition>>	getBuiltInSinksAsync()	Fetches a list of supported Pulsar IO sinks currently running in cluster mode asynchronously.
SinkConfig	getSink(String tenant, String namespace, String sink)	Get the configuration for the specified sink.
CompletableFuture<SinkConfig>	getSinkAsync(String tenant, String namespace, String sink)	Get the configuration for the specified sink asynchronously.
SinkStatus	getSinkStatus(String tenant, String namespace, String sink)	Gets the current status of a sink.
SinkStatus.SinkInstanceStatus.SinkInstanceStatusData	getSinkStatus(String tenant, String namespace, String sink, int id)	Gets the current status of a sink instance.
CompletableFuture<SinkStatus>	getSinkStatusAsync(String tenant, String namespace, String sink)	Gets the current status of a sink asynchronously.
CompletableFuture<SinkStatus.SinkInstanceStatus.SinkInstanceStatusData>	getSinkStatusAsync(String tenant, String namespace, String sink, int id)	Gets the current status of a sink instance asynchronously.
List<String>	listSinks(String tenant, String namespace)	Get the list of sinks.
CompletableFuture<List<String>>	listSinksAsync(String tenant, String namespace)	Get the list of sinks asynchronously.
void	reloadBuiltInSinks()	Reload the available built-in connectors, include Source and Sink.
CompletableFuture<Void>	reloadBuiltInSinksAsync()	Reload the available built-in connectors, include Source and Sink asynchronously.
void	restartSink(String tenant, String namespace, String sink)	Restart all sink instances.
void	restartSink(String tenant, String namespace, String sink, int instanceId)	Restart sink instance.
CompletableFuture<Void>	restartSinkAsync(String tenant, String namespace, String sink)	Restart all sink instances asynchronously.
CompletableFuture<Void>	restartSinkAsync(String tenant, String namespace, String sink, int instanceId)	Restart sink instance asynchronously.
void	startSink(String tenant, String namespace, String sink)	Start all sink instances.
void	startSink(String tenant, String namespace, String sink, int instanceId)	Start sink instance.
CompletableFuture<Void>	startSinkAsync(String tenant, String namespace, String sink)	Start all sink instances asynchronously.
CompletableFuture<Void>	startSinkAsync(String tenant, String namespace, String sink, int instanceId)	Start sink instance asynchronously.
void	stopSink(String tenant, String namespace, String sink)	Stop all sink instances.
void	stopSink(String tenant, String namespace, String sink, int instanceId)	Stop sink instance.
CompletableFuture<Void>	stopSinkAsync(String tenant, String namespace, String sink)	Stop all sink instances asynchronously.
CompletableFuture<Void>	stopSinkAsync(String tenant, String namespace, String sink, int instanceId)	Stop sink instance asynchronously.
void	updateSink(SinkConfig sinkConfig, String fileName)	Update the configuration for a sink.
void	updateSink(SinkConfig sinkConfig, String fileName, UpdateOptions updateOptions)	Update the configuration for a sink.
CompletableFuture<Void>	updateSinkAsync(SinkConfig sinkConfig, String fileName)	Update the configuration for a sink asynchronously.
CompletableFuture<Void>	updateSinkAsync(SinkConfig sinkConfig, String fileName, UpdateOptions updateOptions)	Update the configuration for a sink asynchronously.
void	updateSinkWithUrl(SinkConfig sinkConfig, String pkgUrl)	Update the configuration for a sink.
void	updateSinkWithUrl(SinkConfig sinkConfig, String pkgUrl, UpdateOptions updateOptions)	Update the configuration for a sink.
CompletableFuture<Void>	updateSinkWithUrlAsync(SinkConfig sinkConfig, String pkgUrl)	Update the configuration for a sink asynchronously.
CompletableFuture<Void>	updateSinkWithUrlAsync(SinkConfig sinkConfig, String pkgUrl, UpdateOptions updateOptions)	Update the configuration for a sink asynchronously.

Method Details

listSinks

List<String> listSinks(String tenant,
 String namespace)
                throws PulsarAdminException

Get the list of sinks.

Get the list of all the Pulsar Sinks.

Response Example:

 ["f1", "f2", "f3"]
 

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

listSinksAsync

CompletableFuture<List<String>> listSinksAsync(String tenant,
 String namespace)

Get the list of sinks asynchronously.

Get the list of all the Pulsar Sinks.

Response Example:

 ["f1", "f2", "f3"]
 

getSink

SinkConfig getSink(String tenant,
 String namespace,
 String sink)
            throws PulsarAdminException

Get the configuration for the specified sink.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

Returns:

the sink configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to get the configuration of the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getSinkAsync

CompletableFuture<SinkConfig> getSinkAsync(String tenant,
 String namespace,
 String sink)

Get the configuration for the specified sink asynchronously.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

Returns:

the sink configuration

createSink

void createSink(SinkConfig sinkConfig,
 String fileName)
         throws PulsarAdminException

Create a new sink.

Parameters:

sinkConfig - the sink configuration object

Throws:

PulsarAdminException - Unexpected error

createSinkAsync

CompletableFuture<Void> createSinkAsync(SinkConfig sinkConfig,
 String fileName)

Create a new sink asynchronously.

Parameters:

sinkConfig - the sink configuration object

createSinkWithUrl

void createSinkWithUrl(SinkConfig sinkConfig,
 String pkgUrl)
                throws PulsarAdminException

Create a new sink with package url.

Create a new sink by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

PulsarAdminException

createSinkWithUrlAsync

CompletableFuture<Void> createSinkWithUrlAsync(SinkConfig sinkConfig,
 String pkgUrl)

Create a new sink with package url asynchronously.

Create a new sink by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

updateSink

void updateSink(SinkConfig sinkConfig,
 String fileName)
         throws PulsarAdminException

Update the configuration for a sink.

Parameters:

sinkConfig - the sink configuration object

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSinkAsync

CompletableFuture<Void> updateSinkAsync(SinkConfig sinkConfig,
 String fileName)

Update the configuration for a sink asynchronously.

Parameters:

sinkConfig - the sink configuration object

updateSink

void updateSink(SinkConfig sinkConfig,
 String fileName,
 UpdateOptions updateOptions)
         throws PulsarAdminException

Update the configuration for a sink.

Parameters:

sinkConfig - the sink configuration object

updateOptions - options for the update operations

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSinkAsync

CompletableFuture<Void> updateSinkAsync(SinkConfig sinkConfig,
 String fileName,
 UpdateOptions updateOptions)

Update the configuration for a sink asynchronously.

Parameters:

sinkConfig - the sink configuration object

updateOptions - options for the update operations

updateSinkWithUrl

void updateSinkWithUrl(SinkConfig sinkConfig,
 String pkgUrl)
                throws PulsarAdminException

Update the configuration for a sink.

Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSinkWithUrlAsync

CompletableFuture<Void> updateSinkWithUrlAsync(SinkConfig sinkConfig,
 String pkgUrl)

Update the configuration for a sink asynchronously.

Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

updateSinkWithUrl

void updateSinkWithUrl(SinkConfig sinkConfig,
 String pkgUrl,
 UpdateOptions updateOptions)
                throws PulsarAdminException

Update the configuration for a sink.

Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSinkWithUrlAsync

CompletableFuture<Void> updateSinkWithUrlAsync(SinkConfig sinkConfig,
 String pkgUrl,
 UpdateOptions updateOptions)

Update the configuration for a sink asynchronously.

Update a sink by providing url from which fun-pkg can be downloaded. supported url: http/file eg: File: file:/dir/fileName.jar Http: http://www.repo.com/fileName.jar

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

deleteSink

void deleteSink(String tenant,
 String namespace,
 String sink)
         throws PulsarAdminException

Delete an existing sink.

Delete a sink

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Cluster does not exist

PulsarAdminException.PreconditionFailedException - Cluster is not empty

PulsarAdminException - Unexpected error

deleteSinkAsync

CompletableFuture<Void> deleteSinkAsync(String tenant,
 String namespace,
 String sink)

Delete an existing sink asynchronously.

Delete a sink

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

getSinkStatus

SinkStatus getSinkStatus(String tenant,
 String namespace,
 String sink)
                  throws PulsarAdminException

Gets the current status of a sink.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

Throws:

PulsarAdminException - Unexpected error

getSinkStatusAsync

CompletableFuture<SinkStatus> getSinkStatusAsync(String tenant,
 String namespace,
 String sink)

Gets the current status of a sink asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

getSinkStatus

SinkStatus.SinkInstanceStatus.SinkInstanceStatusData getSinkStatus(String tenant,
 String namespace,
 String sink,
 int id)
                                                            throws PulsarAdminException

Gets the current status of a sink instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

id - Sink instance-id

Returns:

Throws:

PulsarAdminException

getSinkStatusAsync

CompletableFuture<SinkStatus.SinkInstanceStatus.SinkInstanceStatusData> getSinkStatusAsync(String tenant,
 String namespace,
 String sink,
 int id)

Gets the current status of a sink instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

id - Sink instance-id

Returns:

restartSink

void restartSink(String tenant,
 String namespace,
 String sink,
 int instanceId)
          throws PulsarAdminException

Restart sink instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

instanceId - Sink instanceId

Throws:

PulsarAdminException - Unexpected error

restartSinkAsync

CompletableFuture<Void> restartSinkAsync(String tenant,
 String namespace,
 String sink,
 int instanceId)

Restart sink instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

instanceId - Sink instanceId

restartSink

void restartSink(String tenant,
 String namespace,
 String sink)
          throws PulsarAdminException

Restart all sink instances.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

Throws:

PulsarAdminException - Unexpected error

restartSinkAsync

CompletableFuture<Void> restartSinkAsync(String tenant,
 String namespace,
 String sink)

Restart all sink instances asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

stopSink

void stopSink(String tenant,
 String namespace,
 String sink,
 int instanceId)
       throws PulsarAdminException

Stop sink instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

instanceId - Sink instanceId

Throws:

PulsarAdminException - Unexpected error

stopSinkAsync

CompletableFuture<Void> stopSinkAsync(String tenant,
 String namespace,
 String sink,
 int instanceId)

Stop sink instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

instanceId - Sink instanceId

stopSink

void stopSink(String tenant,
 String namespace,
 String sink)
       throws PulsarAdminException

Stop all sink instances.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

Throws:

PulsarAdminException - Unexpected error

stopSinkAsync

CompletableFuture<Void> stopSinkAsync(String tenant,
 String namespace,
 String sink)

Stop all sink instances asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

startSink

void startSink(String tenant,
 String namespace,
 String sink,
 int instanceId)
        throws PulsarAdminException

Start sink instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

instanceId - Sink instanceId

Throws:

PulsarAdminException - Unexpected error

startSinkAsync

CompletableFuture<Void> startSinkAsync(String tenant,
 String namespace,
 String sink,
 int instanceId)

Start sink instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

instanceId - Sink instanceId

startSink

void startSink(String tenant,
 String namespace,
 String sink)
        throws PulsarAdminException

Start all sink instances.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

Throws:

PulsarAdminException - Unexpected error

startSinkAsync

CompletableFuture<Void> startSinkAsync(String tenant,
 String namespace,
 String sink)

Start all sink instances asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

sink - Sink name

getBuiltInSinks

List<ConnectorDefinition> getBuiltInSinks()
                                   throws PulsarAdminException

Fetches a list of supported Pulsar IO sinks currently running in cluster mode.

Throws:

PulsarAdminException - Unexpected error

getBuiltInSinksAsync

CompletableFuture<List<ConnectorDefinition>> getBuiltInSinksAsync()

Fetches a list of supported Pulsar IO sinks currently running in cluster mode asynchronously.

reloadBuiltInSinks

void reloadBuiltInSinks()
                 throws PulsarAdminException

Reload the available built-in connectors, include Source and Sink.

Throws:

PulsarAdminException - Unexpected error

reloadBuiltInSinksAsync

CompletableFuture<Void> reloadBuiltInSinksAsync()

Reload the available built-in connectors, include Source and Sink asynchronously.