Package org.apache.pulsar.client.admin

Interface Sources

All Known Subinterfaces:

Source

public interface Sources

Admin interface for Source management.

Method Summary

Modifier and Type	Method	Description
void	createSource(SourceConfig sourceConfig, String fileName)	Create a new source.
CompletableFuture<Void>	createSourceAsync(SourceConfig sourceConfig, String fileName)	Create a new source asynchronously.
void	createSourceWithUrl(SourceConfig sourceConfig, String pkgUrl)	Create a new source with package url.
CompletableFuture<Void>	createSourceWithUrlAsync(SourceConfig sourceConfig, String pkgUrl)	Create a new source with package url asynchronously.
void	deleteSource(String tenant, String namespace, String source)	Delete an existing source.
CompletableFuture<Void>	deleteSourceAsync(String tenant, String namespace, String source)	Delete an existing source asynchronously.
List<ConnectorDefinition>	getBuiltInSources()	Fetches a list of supported Pulsar IO sources currently running in cluster mode.
CompletableFuture<List<ConnectorDefinition>>	getBuiltInSourcesAsync()	Fetches a list of supported Pulsar IO sources currently running in cluster mode asynchronously.
SourceConfig	getSource(String tenant, String namespace, String source)	Get the configuration for the specified source.
CompletableFuture<SourceConfig>	getSourceAsync(String tenant, String namespace, String source)	Get the configuration for the specified source asynchronously.
SourceStatus	getSourceStatus(String tenant, String namespace, String source)	Gets the current status of a source.
SourceStatus.SourceInstanceStatus.SourceInstanceStatusData	getSourceStatus(String tenant, String namespace, String source, int id)	Gets the current status of a source instance.
CompletableFuture<SourceStatus>	getSourceStatusAsync(String tenant, String namespace, String source)	Gets the current status of a source asynchronously.
CompletableFuture<SourceStatus.SourceInstanceStatus.SourceInstanceStatusData>	getSourceStatusAsync(String tenant, String namespace, String source, int id)	Gets the current status of a source instance asynchronously.
List<String>	listSources(String tenant, String namespace)	Get the list of sources.
CompletableFuture<List<String>>	listSourcesAsync(String tenant, String namespace)	Get the list of sources asynchronously.
void	reloadBuiltInSources()	Reload the available built-in connectors, include Source and Source.
CompletableFuture<Void>	reloadBuiltInSourcesAsync()	Reload the available built-in connectors, include Source and Source asynchronously.
void	restartSource(String tenant, String namespace, String source)	Restart all source instances.
void	restartSource(String tenant, String namespace, String source, int instanceId)	Restart source instance.
CompletableFuture<Void>	restartSourceAsync(String tenant, String namespace, String source)	Restart all source instances asynchronously.
CompletableFuture<Void>	restartSourceAsync(String tenant, String namespace, String source, int instanceId)	Restart source instance asynchronously.
void	startSource(String tenant, String namespace, String source)	Start all source instances.
void	startSource(String tenant, String namespace, String source, int instanceId)	Start source instance.
CompletableFuture<Void>	startSourceAsync(String tenant, String namespace, String source)	Start all source instances asynchronously.
CompletableFuture<Void>	startSourceAsync(String tenant, String namespace, String source, int instanceId)	Start source instance asynchronously.
void	stopSource(String tenant, String namespace, String source)	Stop all source instances.
void	stopSource(String tenant, String namespace, String source, int instanceId)	Stop source instance.
CompletableFuture<Void>	stopSourceAsync(String tenant, String namespace, String source)	Stop all source instances asynchronously.
CompletableFuture<Void>	stopSourceAsync(String tenant, String namespace, String source, int instanceId)	Stop source instance asynchronously.
void	updateSource(SourceConfig sourceConfig, String fileName)	Update the configuration for a source.
void	updateSource(SourceConfig sourceConfig, String fileName, UpdateOptions updateOptions)	Update the configuration for a source.
CompletableFuture<Void>	updateSourceAsync(SourceConfig sourceConfig, String fileName)	Update the configuration for a source asynchronously.
CompletableFuture<Void>	updateSourceAsync(SourceConfig sourceConfig, String fileName, UpdateOptions updateOptions)	Update the configuration for a source asynchronously.
void	updateSourceWithUrl(SourceConfig sourceConfig, String pkgUrl)	Update the configuration for a source.
void	updateSourceWithUrl(SourceConfig sourceConfig, String pkgUrl, UpdateOptions updateOptions)	Update the configuration for a source.
CompletableFuture<Void>	updateSourceWithUrlAsync(SourceConfig sourceConfig, String pkgUrl)	Update the configuration for a source asynchronously.
CompletableFuture<Void>	updateSourceWithUrlAsync(SourceConfig sourceConfig, String pkgUrl, UpdateOptions updateOptions)	Update the configuration for a source asynchronously.

Method Details

listSources

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

Get the list of sources.

Get the list of all the Pulsar Sources.

Response Example:

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

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

listSourcesAsync

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

Get the list of sources asynchronously.

Get the list of all the Pulsar Sources.

Response Example:

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

getSource

SourceConfig getSource(String tenant,
 String namespace,
 String source)
                throws PulsarAdminException

Get the configuration for the specified source.

Response Example:

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

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

Returns:

the source 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

getSourceAsync

CompletableFuture<SourceConfig> getSourceAsync(String tenant,
 String namespace,
 String source)

Get the configuration for the specified source asynchronously.

Response Example:

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

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

Returns:

the source configuration

createSource

void createSource(SourceConfig sourceConfig,
 String fileName)
           throws PulsarAdminException

Create a new source.

Parameters:

sourceConfig - the source configuration object

Throws:

PulsarAdminException - Unexpected error

createSourceAsync

CompletableFuture<Void> createSourceAsync(SourceConfig sourceConfig,
 String fileName)

Create a new source asynchronously.

Parameters:

sourceConfig - the source configuration object

createSourceWithUrl

void createSourceWithUrl(SourceConfig sourceConfig,
 String pkgUrl)
                  throws PulsarAdminException

Create a new source with package url.

Create a new source 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:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

Throws:

PulsarAdminException

createSourceWithUrlAsync

CompletableFuture<Void> createSourceWithUrlAsync(SourceConfig sourceConfig,
 String pkgUrl)

Create a new source with package url asynchronously.

Create a new source 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:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

updateSource

void updateSource(SourceConfig sourceConfig,
 String fileName)
           throws PulsarAdminException

Update the configuration for a source.

Parameters:

sourceConfig - the source configuration object

Throws:

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

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateSourceAsync

CompletableFuture<Void> updateSourceAsync(SourceConfig sourceConfig,
 String fileName)

Update the configuration for a source asynchronously.

Parameters:

sourceConfig - the source configuration object

updateSource

void updateSource(SourceConfig sourceConfig,
 String fileName,
 UpdateOptions updateOptions)
           throws PulsarAdminException

Update the configuration for a source.

Parameters:

sourceConfig - the source 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

updateSourceAsync

CompletableFuture<Void> updateSourceAsync(SourceConfig sourceConfig,
 String fileName,
 UpdateOptions updateOptions)

Update the configuration for a source asynchronously.

Parameters:

sourceConfig - the source configuration object

updateOptions - options for the update operations

updateSourceWithUrl

void updateSourceWithUrl(SourceConfig sourceConfig,
 String pkgUrl)
                  throws PulsarAdminException

Update the configuration for a source.

Update a source 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:

sourceConfig - the source 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

updateSourceWithUrlAsync

CompletableFuture<Void> updateSourceWithUrlAsync(SourceConfig sourceConfig,
 String pkgUrl)

Update the configuration for a source asynchronously.

Update a source 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:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

updateSourceWithUrl

void updateSourceWithUrl(SourceConfig sourceConfig,
 String pkgUrl,
 UpdateOptions updateOptions)
                  throws PulsarAdminException

Update the configuration for a source.

Update a source 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:

sourceConfig - the source 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

updateSourceWithUrlAsync

CompletableFuture<Void> updateSourceWithUrlAsync(SourceConfig sourceConfig,
 String pkgUrl,
 UpdateOptions updateOptions)

Update the configuration for a source asynchronously.

Update a source 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:

sourceConfig - the source configuration object

pkgUrl - url from which pkg can be downloaded

updateOptions - options for the update operations

deleteSource

void deleteSource(String tenant,
 String namespace,
 String source)
           throws PulsarAdminException

Delete an existing source.

Delete a source

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source 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

deleteSourceAsync

CompletableFuture<Void> deleteSourceAsync(String tenant,
 String namespace,
 String source)

Delete an existing source asynchronously.

Delete a source

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

getSourceStatus

SourceStatus getSourceStatus(String tenant,
 String namespace,
 String source)
                      throws PulsarAdminException

Gets the current status of a source.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

Throws:

PulsarAdminException - Unexpected error

getSourceStatusAsync

CompletableFuture<SourceStatus> getSourceStatusAsync(String tenant,
 String namespace,
 String source)

Gets the current status of a source asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

getSourceStatus

SourceStatus.SourceInstanceStatus.SourceInstanceStatusData getSourceStatus(String tenant,
 String namespace,
 String source,
 int id)
                                                                    throws PulsarAdminException

Gets the current status of a source instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

id - Source instance-id

Returns:

Throws:

PulsarAdminException

getSourceStatusAsync

CompletableFuture<SourceStatus.SourceInstanceStatus.SourceInstanceStatusData> getSourceStatusAsync(String tenant,
 String namespace,
 String source,
 int id)

Gets the current status of a source instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

id - Source instance-id

Returns:

restartSource

void restartSource(String tenant,
 String namespace,
 String source,
 int instanceId)
            throws PulsarAdminException

Restart source instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

instanceId - Source instanceId

Throws:

PulsarAdminException - Unexpected error

restartSourceAsync

CompletableFuture<Void> restartSourceAsync(String tenant,
 String namespace,
 String source,
 int instanceId)

Restart source instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

instanceId - Source instanceId

restartSource

void restartSource(String tenant,
 String namespace,
 String source)
            throws PulsarAdminException

Restart all source instances.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

Throws:

PulsarAdminException - Unexpected error

restartSourceAsync

CompletableFuture<Void> restartSourceAsync(String tenant,
 String namespace,
 String source)

Restart all source instances asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

stopSource

void stopSource(String tenant,
 String namespace,
 String source,
 int instanceId)
         throws PulsarAdminException

Stop source instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

instanceId - Source instanceId

Throws:

PulsarAdminException - Unexpected error

stopSourceAsync

CompletableFuture<Void> stopSourceAsync(String tenant,
 String namespace,
 String source,
 int instanceId)

Stop source instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

instanceId - Source instanceId

stopSource

void stopSource(String tenant,
 String namespace,
 String source)
         throws PulsarAdminException

Stop all source instances.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

Throws:

PulsarAdminException - Unexpected error

stopSourceAsync

CompletableFuture<Void> stopSourceAsync(String tenant,
 String namespace,
 String source)

Stop all source instances asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

startSource

void startSource(String tenant,
 String namespace,
 String source,
 int instanceId)
          throws PulsarAdminException

Start source instance.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

instanceId - Source instanceId

Throws:

PulsarAdminException - Unexpected error

startSourceAsync

CompletableFuture<Void> startSourceAsync(String tenant,
 String namespace,
 String source,
 int instanceId)

Start source instance asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

instanceId - Source instanceId

startSource

void startSource(String tenant,
 String namespace,
 String source)
          throws PulsarAdminException

Start all source instances.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

Throws:

PulsarAdminException - Unexpected error

startSourceAsync

CompletableFuture<Void> startSourceAsync(String tenant,
 String namespace,
 String source)

Start all source instances asynchronously.

Parameters:

tenant - Tenant name

namespace - Namespace name

source - Source name

getBuiltInSources

List<ConnectorDefinition> getBuiltInSources()
                                     throws PulsarAdminException

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

Throws:

PulsarAdminException - Unexpected error

getBuiltInSourcesAsync

CompletableFuture<List<ConnectorDefinition>> getBuiltInSourcesAsync()

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

reloadBuiltInSources

void reloadBuiltInSources()
                   throws PulsarAdminException

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

Throws:

PulsarAdminException - Unexpected error

reloadBuiltInSourcesAsync

CompletableFuture<Void> reloadBuiltInSourcesAsync()

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