org.apache.pulsar.client.admin.internal

Class SinksImpl

java.lang.Object

org.apache.pulsar.client.admin.internal.BaseResource

org.apache.pulsar.client.admin.internal.ComponentResource

org.apache.pulsar.client.admin.internal.SinksImpl

All Implemented Interfaces:

Sink, Sinks

public class SinksImpl
extends ComponentResource
implements Sinks, Sink

Field Summary

Fields inherited from class org.apache.pulsar.client.admin.internal.BaseResource

auth, readTimeoutMs

Constructor Summary

Constructors

Constructor and Description
SinksImpl(javax.ws.rs.client.WebTarget web, org.apache.pulsar.client.api.Authentication auth, org.asynchttpclient.AsyncHttpClient asyncHttpClient, long readTimeoutMs)

Method Summary

Modifier and Type	Method and Description
void	createSink(org.apache.pulsar.common.io.SinkConfig sinkConfig, String fileName) Create a new sink.
CompletableFuture<Void>	createSinkAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig, String fileName) Create a new sink asynchronously.
void	createSinkWithUrl(org.apache.pulsar.common.io.SinkConfig sinkConfig, String pkgUrl) Create a new sink with package url.
CompletableFuture<Void>	createSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig, String pkgUrl) Create a new sink with package url asynchronously.
void	deleteSink(String cluster, String namespace, String function) Delete an existing sink.
CompletableFuture<Void>	deleteSinkAsync(String tenant, String namespace, String function) Delete an existing sink asynchronously.
List<org.apache.pulsar.common.io.ConnectorDefinition>	getBuiltInSinks() Fetches a list of supported Pulsar IO sinks currently running in cluster mode.
CompletableFuture<List<org.apache.pulsar.common.io.ConnectorDefinition>>	getBuiltInSinksAsync() Fetches a list of supported Pulsar IO sinks currently running in cluster mode asynchronously.
org.apache.pulsar.common.io.SinkConfig	getSink(String tenant, String namespace, String sinkName) Get the configuration for the specified sink.
CompletableFuture<org.apache.pulsar.common.io.SinkConfig>	getSinkAsync(String tenant, String namespace, String sinkName) Get the configuration for the specified sink asynchronously.
org.apache.pulsar.common.policies.data.SinkStatus	getSinkStatus(String tenant, String namespace, String sinkName) Gets the current status of a sink.
org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData	getSinkStatus(String tenant, String namespace, String sinkName, int id) Gets the current status of a sink instance.
CompletableFuture<org.apache.pulsar.common.policies.data.SinkStatus>	getSinkStatusAsync(String tenant, String namespace, String sinkName) Gets the current status of a sink asynchronously.
CompletableFuture<org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData>	getSinkStatusAsync(String tenant, String namespace, String sinkName, 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 functionName) Restart all sink instances.
void	restartSink(String tenant, String namespace, String functionName, int instanceId) Restart sink instance.
CompletableFuture<Void>	restartSinkAsync(String tenant, String namespace, String functionName) Restart all sink instances asynchronously.
CompletableFuture<Void>	restartSinkAsync(String tenant, String namespace, String functionName, int instanceId) Restart sink instance asynchronously.
void	startSink(String tenant, String namespace, String sinkName) Start all sink instances.
void	startSink(String tenant, String namespace, String sinkName, int instanceId) Start sink instance.
CompletableFuture<Void>	startSinkAsync(String tenant, String namespace, String sinkName) Start all sink instances asynchronously.
CompletableFuture<Void>	startSinkAsync(String tenant, String namespace, String sinkName, int instanceId) Start sink instance asynchronously.
void	stopSink(String tenant, String namespace, String sinkName) Stop all sink instances.
void	stopSink(String tenant, String namespace, String sinkName, int instanceId) Stop sink instance.
CompletableFuture<Void>	stopSinkAsync(String tenant, String namespace, String sinkName) Stop all sink instances asynchronously.
CompletableFuture<Void>	stopSinkAsync(String tenant, String namespace, String sinkName, int instanceId) Stop sink instance asynchronously.
void	updateSink(org.apache.pulsar.common.io.SinkConfig sinkConfig, String fileName) Update the configuration for a sink.
void	updateSink(org.apache.pulsar.common.io.SinkConfig sinkConfig, String fileName, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a sink.
CompletableFuture<Void>	updateSinkAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig, String fileName) Update the configuration for a sink asynchronously.
CompletableFuture<Void>	updateSinkAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig, String fileName, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a sink asynchronously.
void	updateSinkWithUrl(org.apache.pulsar.common.io.SinkConfig sinkConfig, String pkgUrl) Update the configuration for a sink.
void	updateSinkWithUrl(org.apache.pulsar.common.io.SinkConfig sinkConfig, String pkgUrl, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a sink.
CompletableFuture<Void>	updateSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig, String pkgUrl) Update the configuration for a sink asynchronously.
CompletableFuture<Void>	updateSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig, String pkgUrl, org.apache.pulsar.common.functions.UpdateOptions updateOptions) Update the configuration for a sink asynchronously.

Methods inherited from class org.apache.pulsar.client.admin.internal.ComponentResource

addAuthHeaders

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, getApiException, request, requestAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SinksImpl

public SinksImpl(javax.ws.rs.client.WebTarget web,
                 org.apache.pulsar.client.api.Authentication auth,
                 org.asynchttpclient.AsyncHttpClient asyncHttpClient,
                 long readTimeoutMs)

Method Detail

listSinks

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

Description copied from interface: Sinks

Get the list of sinks.

Get the list of all the Pulsar Sinks.

Response Example:

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

Specified by:

listSinks in interface Sinks

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

listSinksAsync

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

Description copied from interface: Sinks

Get the list of sinks asynchronously.

Get the list of all the Pulsar Sinks.

Response Example:

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

Specified by:

listSinksAsync in interface Sinks

getSink

public org.apache.pulsar.common.io.SinkConfig getSink(String tenant,
                                                      String namespace,
                                                      String sinkName)
                                               throws PulsarAdminException

Description copied from interface: Sinks

Get the configuration for the specified sink.

Response Example:

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

Specified by:

getSink in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - 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

public CompletableFuture<org.apache.pulsar.common.io.SinkConfig> getSinkAsync(String tenant,
                                                                              String namespace,
                                                                              String sinkName)

Description copied from interface: Sinks

Get the configuration for the specified sink asynchronously.

Response Example:

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

Specified by:

getSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

Returns:

the sink configuration

getSinkStatus

public org.apache.pulsar.common.policies.data.SinkStatus getSinkStatus(String tenant,
                                                                       String namespace,
                                                                       String sinkName)
                                                                throws PulsarAdminException

Description copied from interface: Sinks

Gets the current status of a sink.

Specified by:

getSinkStatus in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

Throws:

PulsarAdminException - Unexpected error

getSinkStatusAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.SinkStatus> getSinkStatusAsync(String tenant,
                                                                                               String namespace,
                                                                                               String sinkName)

Description copied from interface: Sinks

Gets the current status of a sink asynchronously.

Specified by:

getSinkStatusAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

getSinkStatus

public org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData getSinkStatus(String tenant,
                                                                                                                 String namespace,
                                                                                                                 String sinkName,
                                                                                                                 int id)
                                                                                                          throws PulsarAdminException

Description copied from interface: Sinks

Gets the current status of a sink instance.

Specified by:

getSinkStatus in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

id - Sink instance-id

Returns:

Throws:

PulsarAdminException

getSinkStatusAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.SinkStatus.SinkInstanceStatus.SinkInstanceStatusData> getSinkStatusAsync(String tenant,
                                                                                                                                         String namespace,
                                                                                                                                         String sinkName,
                                                                                                                                         int id)

Description copied from interface: Sinks

Gets the current status of a sink instance asynchronously.

Specified by:

getSinkStatusAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

id - Sink instance-id

Returns:

createSink

public void createSink(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                       String fileName)
                throws PulsarAdminException

Description copied from interface: Sinks

Create a new sink.

Specified by:

createSink in interface Sinks

Parameters:

sinkConfig - the sink configuration object

Throws:

PulsarAdminException - Unexpected error

createSinkAsync

public CompletableFuture<Void> createSinkAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                               String fileName)

Description copied from interface: Sinks

Create a new sink asynchronously.

Specified by:

createSinkAsync in interface Sinks

Parameters:

sinkConfig - the sink configuration object

createSinkWithUrl

public void createSinkWithUrl(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                              String pkgUrl)
                       throws PulsarAdminException

Description copied from interface: Sinks

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

Specified by:

createSinkWithUrl in interface Sinks

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

PulsarAdminException

createSinkWithUrlAsync

public CompletableFuture<Void> createSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                                      String pkgUrl)

Description copied from interface: Sinks

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

Specified by:

createSinkWithUrlAsync in interface Sinks

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

deleteSink

public void deleteSink(String cluster,
                       String namespace,
                       String function)
                throws PulsarAdminException

Description copied from interface: Sinks

Delete an existing sink.

Delete a sink

Specified by:

deleteSink in interface Sinks

Parameters:

cluster - Tenant name

namespace - Namespace name

function - 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

public CompletableFuture<Void> deleteSinkAsync(String tenant,
                                               String namespace,
                                               String function)

Description copied from interface: Sinks

Delete an existing sink asynchronously.

Delete a sink

Specified by:

deleteSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

function - Sink name

updateSink

public void updateSink(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                       String fileName,
                       org.apache.pulsar.common.functions.UpdateOptions updateOptions)
                throws PulsarAdminException

Description copied from interface: Sinks

Update the configuration for a sink.

Specified by:

updateSink in interface Sinks

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

public CompletableFuture<Void> updateSinkAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                               String fileName,
                                               org.apache.pulsar.common.functions.UpdateOptions updateOptions)

Description copied from interface: Sinks

Update the configuration for a sink asynchronously.

Specified by:

updateSinkAsync in interface Sinks

Parameters:

sinkConfig - the sink configuration object

updateOptions - options for the update operations

updateSink

public void updateSink(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                       String fileName)
                throws PulsarAdminException

Description copied from interface: Sinks

Update the configuration for a sink.

Specified by:

updateSink in interface Sinks

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

public CompletableFuture<Void> updateSinkAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                               String fileName)

Description copied from interface: Sinks

Update the configuration for a sink asynchronously.

Specified by:

updateSinkAsync in interface Sinks

Parameters:

sinkConfig - the sink configuration object

updateSinkWithUrl

public void updateSinkWithUrl(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                              String pkgUrl,
                              org.apache.pulsar.common.functions.UpdateOptions updateOptions)
                       throws PulsarAdminException

Description copied from interface: Sinks

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

Specified by:

updateSinkWithUrl in interface Sinks

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

public CompletableFuture<Void> updateSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                                      String pkgUrl,
                                                      org.apache.pulsar.common.functions.UpdateOptions updateOptions)

Description copied from interface: Sinks

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

Specified by:

updateSinkWithUrlAsync in interface Sinks

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

updateSinkWithUrl

public void updateSinkWithUrl(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                              String pkgUrl)
                       throws PulsarAdminException

Description copied from interface: Sinks

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

Specified by:

updateSinkWithUrl in interface Sinks

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

public CompletableFuture<Void> updateSinkWithUrlAsync(org.apache.pulsar.common.io.SinkConfig sinkConfig,
                                                      String pkgUrl)

Description copied from interface: Sinks

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

Specified by:

updateSinkWithUrlAsync in interface Sinks

Parameters:

sinkConfig - the sink configuration object

pkgUrl - url from which pkg can be downloaded

restartSink

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

Description copied from interface: Sinks

Restart sink instance.

Specified by:

restartSink in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Sink name

instanceId - Sink instanceId

Throws:

PulsarAdminException - Unexpected error

restartSinkAsync

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

Description copied from interface: Sinks

Restart sink instance asynchronously.

Specified by:

restartSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Sink name

instanceId - Sink instanceId

restartSink

public void restartSink(String tenant,
                        String namespace,
                        String functionName)
                 throws PulsarAdminException

Description copied from interface: Sinks

Restart all sink instances.

Specified by:

restartSink in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Sink name

Throws:

PulsarAdminException - Unexpected error

restartSinkAsync

public CompletableFuture<Void> restartSinkAsync(String tenant,
                                                String namespace,
                                                String functionName)

Description copied from interface: Sinks

Restart all sink instances asynchronously.

Specified by:

restartSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

functionName - Sink name

stopSink

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

Description copied from interface: Sinks

Stop sink instance.

Specified by:

stopSink in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

instanceId - Sink instanceId

Throws:

PulsarAdminException - Unexpected error

stopSinkAsync

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

Description copied from interface: Sinks

Stop sink instance asynchronously.

Specified by:

stopSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

instanceId - Sink instanceId

stopSink

public void stopSink(String tenant,
                     String namespace,
                     String sinkName)
              throws PulsarAdminException

Description copied from interface: Sinks

Stop all sink instances.

Specified by:

stopSink in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

Throws:

PulsarAdminException - Unexpected error

stopSinkAsync

public CompletableFuture<Void> stopSinkAsync(String tenant,
                                             String namespace,
                                             String sinkName)

Description copied from interface: Sinks

Stop all sink instances asynchronously.

Specified by:

stopSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

startSink

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

Description copied from interface: Sinks

Start sink instance.

Specified by:

startSink in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

instanceId - Sink instanceId

Throws:

PulsarAdminException - Unexpected error

startSinkAsync

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

Description copied from interface: Sinks

Start sink instance asynchronously.

Specified by:

startSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

instanceId - Sink instanceId

startSink

public void startSink(String tenant,
                      String namespace,
                      String sinkName)
               throws PulsarAdminException

Description copied from interface: Sinks

Start all sink instances.

Specified by:

startSink in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

Throws:

PulsarAdminException - Unexpected error

startSinkAsync

public CompletableFuture<Void> startSinkAsync(String tenant,
                                              String namespace,
                                              String sinkName)

Description copied from interface: Sinks

Start all sink instances asynchronously.

Specified by:

startSinkAsync in interface Sinks

Parameters:

tenant - Tenant name

namespace - Namespace name

sinkName - Sink name

getBuiltInSinks

public List<org.apache.pulsar.common.io.ConnectorDefinition> getBuiltInSinks()
                                                                      throws PulsarAdminException

Description copied from interface: Sinks

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

Specified by:

getBuiltInSinks in interface Sinks

Throws:

PulsarAdminException - Unexpected error

getBuiltInSinksAsync

public CompletableFuture<List<org.apache.pulsar.common.io.ConnectorDefinition>> getBuiltInSinksAsync()

Description copied from interface: Sinks

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

Specified by:

getBuiltInSinksAsync in interface Sinks

reloadBuiltInSinks

public void reloadBuiltInSinks()
                        throws PulsarAdminException

Description copied from interface: Sinks

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

Specified by:

reloadBuiltInSinks in interface Sinks

Throws:

PulsarAdminException - Unexpected error

reloadBuiltInSinksAsync

public CompletableFuture<Void> reloadBuiltInSinksAsync()

Description copied from interface: Sinks

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

Specified by:

reloadBuiltInSinksAsync in interface Sinks