org.apache.pulsar.client.admin

Interface Packages

public interface Packages

Administration operations of the packages management service.

Method Summary

Modifier and Type	Method and Description
void	delete(String packageName) Delete the specified package.
CompletableFuture<Void>	deleteAsync(String packageName) Delete the specified package asynchronously.
void	download(String packageName, String path) Download a package from the package management service.
CompletableFuture<Void>	downloadAsync(String packageName, String path) Download a package from the package management service asynchronously.
PackageMetadata	getMetadata(String packageName) Get a package metadata information.
CompletableFuture<PackageMetadata>	getMetadataAsync(String packageName) Get a package metadata information asynchronously.
List<String>	listPackages(String type, String namespace) List all the packages with the given type in a namespace.
CompletableFuture<List<String>>	listPackagesAsync(String type, String namespace) List all the packages with the given type in a namespace asynchronously.
List<String>	listPackageVersions(String packageName) List all the versions of a package.
CompletableFuture<List<String>>	listPackageVersionsAsync(String packageName) List all the versions of a package asynchronously.
void	updateMetadata(String packageName, PackageMetadata metadata) Update a package metadata information.
CompletableFuture<Void>	updateMetadataAsync(String packageName, PackageMetadata metadata) Update a package metadata information asynchronously.
void	upload(PackageMetadata metadata, String packageName, String path) Upload a package to the package management service.
CompletableFuture<Void>	uploadAsync(PackageMetadata metadata, String packageName, String path) Upload a package to the package management service asynchronously.

Method Detail

getMetadata

PackageMetadata getMetadata(String packageName)
                     throws PulsarAdminException

Get a package metadata information.

Parameters:

packageName - the package name of the package metadata you want to find

Returns:

the package metadata information

Throws:

PulsarAdminException

getMetadataAsync

CompletableFuture<PackageMetadata> getMetadataAsync(String packageName)

Get a package metadata information asynchronously.

Parameters:

packageName - the package name of the package metadata you want to find

Returns:

the package metadata information

updateMetadata

void updateMetadata(String packageName,
                    PackageMetadata metadata)
             throws PulsarAdminException

Update a package metadata information.

Parameters:

packageName - the package name of the package metadata you want to update

metadata - the updated metadata information

Throws:

PulsarAdminException

updateMetadataAsync

CompletableFuture<Void> updateMetadataAsync(String packageName,
                                            PackageMetadata metadata)

Update a package metadata information asynchronously.

Parameters:

packageName - the package name of the package metadata you want to update

metadata - the updated metadata information

Returns:

nothing

upload

void upload(PackageMetadata metadata,
            String packageName,
            String path)
     throws PulsarAdminException

Upload a package to the package management service.

Parameters:

packageName - the package name of the upload file

path - the upload file path

Throws:

PulsarAdminException

uploadAsync

CompletableFuture<Void> uploadAsync(PackageMetadata metadata,
                                    String packageName,
                                    String path)

Upload a package to the package management service asynchronously.

Parameters:

packageName - the package name you want to upload

path - the path you want to upload from

Returns:

nothing

download

void download(String packageName,
              String path)
       throws PulsarAdminException

Download a package from the package management service.

Parameters:

packageName - the package name you want to download

path - the path you want to download to

Throws:

PulsarAdminException

downloadAsync

CompletableFuture<Void> downloadAsync(String packageName,
                                      String path)

Download a package from the package management service asynchronously.

Parameters:

packageName - the package name you want to download

path - the path you want to download to

Returns:

nothing

delete

void delete(String packageName)
     throws PulsarAdminException

Delete the specified package.

Parameters:

packageName - the package name which you want to delete

Throws:

PulsarAdminException

deleteAsync

CompletableFuture<Void> deleteAsync(String packageName)

Delete the specified package asynchronously.

Parameters:

packageName - the package name which you want to delete

Returns:

nothing

listPackageVersions

List<String> listPackageVersions(String packageName)
                          throws PulsarAdminException

List all the versions of a package.

Parameters:

packageName - the package name which you want to get all the versions

Returns:

all the versions of the package

Throws:

PulsarAdminException

listPackageVersionsAsync

CompletableFuture<List<String>> listPackageVersionsAsync(String packageName)

List all the versions of a package asynchronously.

Parameters:

packageName - the package name which you want to get all the versions

Returns:

all the versions of the package

listPackages

List<String> listPackages(String type,
                          String namespace)
                   throws PulsarAdminException

List all the packages with the given type in a namespace.

Parameters:

type - the type you want to get the packages

namespace - the namespace you want to get the packages

Returns:

all the packages of the given type which in the given namespace

Throws:

PulsarAdminException

listPackagesAsync

CompletableFuture<List<String>> listPackagesAsync(String type,
                                                  String namespace)

List all the packages with the given type in a namespace asynchronously.

Parameters:

type - the type you want to get the packages

namespace - the namespace you want to get the packages

Returns:

all the packages of the given type which in the given namespace