PulsarAdmin (Pulsar Client Admin Original 2.0.0-rc1-incubating API)

java.lang.Object
- org.apache.pulsar.client.admin.PulsarAdmin

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class PulsarAdmin
extends Object
implements Closeable
```
Pulsar client admin API client.

Field Summary

Fields
Modifier and Type Field and Description

protected Authentication auth

protected javax.ws.rs.client.WebTarget root

Fields
Modifier and Type	Field and Description
`protected Authentication`	`auth`
`protected javax.ws.rs.client.WebTarget`	`root`

Constructor Summary

Constructors
Constructor and Description
`PulsarAdmin(String serviceUrl, ClientConfigurationData clientConfigData)`
`PulsarAdmin(URL serviceUrl, Authentication auth)` Deprecated. Since 2.0. Use `builder()` to construct a new `PulsarAdmin` instance.
`PulsarAdmin(URL serviceUrl, ClientConfiguration pulsarConfig)` Deprecated. Since 2.0. Use `builder()` to construct a new `PulsarAdmin` instance.
`PulsarAdmin(URL serviceUrl, String authPluginClassName, Map<String,String> authParams)` Deprecated. Since 2.0. Use `builder()` to construct a new `PulsarAdmin` instance.
`PulsarAdmin(URL serviceUrl, String authPluginClassName, String authParamsString)` Deprecated. Since 2.0. Use `builder()` to construct a new `PulsarAdmin` instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Brokers`	`brokers()`
`BrokerStats`	`brokerStats()`
`static PulsarAdminBuilder`	`builder()` Creates a builder to construct an instance of `PulsarAdmin`.
`void`	`close()` Close the Pulsar admin client to release all the resources
`Clusters`	`clusters()`
`Functions`	`functions()`
`ClientConfigurationData`	`getClientConfigData()`
`String`	`getServiceUrl()`
`Lookup`	`lookups()`
`Namespaces`	`namespaces()`
`NonPersistentTopics`	`nonPersistentTopics()` Deprecated. Since 2.0. See `topics()`
`PersistentTopics`	`persistentTopics()` Deprecated. Since 2.0. See `topics()`
`Properties`	`properties()` Deprecated. since 2.0. See `tenants()`
`ResourceQuotas`	`resourceQuotas()`
`Tenants`	`tenants()`
`Topics`	`topics()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - root
```
protected final javax.ws.rs.client.WebTarget root
```
  - auth
```
protected final Authentication auth
```
- Constructor Detail
  - PulsarAdmin
```
public PulsarAdmin(String serviceUrl,
                   ClientConfigurationData clientConfigData)
            throws PulsarClientException
```
    Throws:
    
    PulsarClientException
  - PulsarAdmin
```
@Deprecated
public PulsarAdmin(URL serviceUrl,
                               ClientConfiguration pulsarConfig)
                        throws PulsarClientException
```
    Deprecated. Since 2.0. Use builder() to construct a new PulsarAdmin instance.
    
    Construct a new Pulsar Admin client object.
    This client object can be used to perform many subsquent API calls
    
    Parameters:
    
    serviceUrl - the Pulsar service URL (eg. "http://my-broker.example.com:8080")
    
    pulsarConfig - the ClientConfiguration object to be used to talk with Pulsar
    
    Throws:
    
    PulsarClientException
  - PulsarAdmin
```
@Deprecated
public PulsarAdmin(URL serviceUrl,
                               Authentication auth)
                        throws PulsarClientException
```
    Deprecated. Since 2.0. Use builder() to construct a new PulsarAdmin instance.
    
    Construct a new Pulsar Admin client object.
    This client object can be used to perform many subsquent API calls
    
    Parameters:
    
    serviceUrl - the Pulsar service URL (eg. "http://my-broker.example.com:8080")
    
    auth - the Authentication object to be used to talk with Pulsar
    
    Throws:
    
    PulsarClientException
  - PulsarAdmin
```
@Deprecated
public PulsarAdmin(URL serviceUrl,
                               String authPluginClassName,
                               String authParamsString)
                        throws PulsarClientException
```
    Deprecated. Since 2.0. Use builder() to construct a new PulsarAdmin instance.
    
    Construct a new Pulsar Admin client object.
    This client object can be used to perform many subsquent API calls
    
    Parameters:
    
    serviceUrl - the Pulsar URL (eg. "http://my-broker.example.com:8080")
    
    authPluginClassName - name of the Authentication-Plugin you want to use
    
    authParamsString - string which represents parameters for the Authentication-Plugin, e.g., "key1:val1,key2:val2"
    
    Throws:
    
    PulsarClientException
  - PulsarAdmin
```
@Deprecated
public PulsarAdmin(URL serviceUrl,
                               String authPluginClassName,
                               Map<String,String> authParams)
                        throws PulsarClientException
```
    Deprecated. Since 2.0. Use builder() to construct a new PulsarAdmin instance.
    
    Construct a new Pulsar Admin client object.
    This client object can be used to perform many subsquent API calls
    
    Parameters:
    
    serviceUrl - the Pulsar URL (eg. "http://my-broker.example.com:8080")
    
    authPluginClassName - name of the Authentication-Plugin you want to use
    
    authParams - map which represents parameters for the Authentication-Plugin
    
    Throws:
    
    PulsarClientException
- Method Detail
  - builder
```
public static PulsarAdminBuilder builder()
```
    Creates a builder to construct an instance of PulsarAdmin.
  - clusters
```
public Clusters clusters()
```
    Returns:
    
    the clusters management object
  - brokers
```
public Brokers brokers()
```
    Returns:
    
    the brokers management object
  - tenants
```
public Tenants tenants()
```
    Returns:
    
    the tenants management object
  - properties
```
@Deprecated
public Properties properties()
```
    Deprecated. since 2.0. See tenants()
  - namespaces
```
public Namespaces namespaces()
```
    Returns:
    
    the namespaces management object
  - topics
```
public Topics topics()
```
  - persistentTopics
```
@Deprecated
public PersistentTopics persistentTopics()
```
    Deprecated. Since 2.0. See topics()
    
    Returns:
    
    the persistentTopics management object
  - nonPersistentTopics
```
@Deprecated
public NonPersistentTopics nonPersistentTopics()
```
    Deprecated. Since 2.0. See topics()
    
    Returns:
    
    the persistentTopics management object
  - resourceQuotas
```
public ResourceQuotas resourceQuotas()
```
    Returns:
    
    the resource quota management object
  - lookups
```
public Lookup lookups()
```
    Returns:
    
    does a looks up for the broker serving the topic
  - functions
```
public Functions functions()
```
    Returns:
    
    the functions management object
  - brokerStats
```
public BrokerStats brokerStats()
```
    Returns:
    
    the broker statics
  - getServiceUrl
```
public String getServiceUrl()
```
    Returns:
    
    the service HTTP URL that is being used
  - getClientConfigData
```
public ClientConfigurationData getClientConfigData()
```
    Returns:
    
    the client Configuration Data that is being used
  - close
```
public void close()
```
    Close the Pulsar admin client to release all the resources
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Class PulsarAdmin

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

root

auth

Constructor Detail

PulsarAdmin

PulsarAdmin

PulsarAdmin

PulsarAdmin

PulsarAdmin

Method Detail

builder

clusters

brokers

tenants

properties

namespaces

topics

persistentTopics

nonPersistentTopics

resourceQuotas

lookups

functions

brokerStats

getServiceUrl

getClientConfigData

close