PulsarAdmin (Pulsar Client Admin Original 2.7.0-SNAPSHOT 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 org.apache.pulsar.client.api.Authentication`	`auth`
`static int`	`DEFAULT_CONNECT_TIMEOUT_SECONDS`
`static int`	`DEFAULT_READ_TIMEOUT_SECONDS`
`static int`	`DEFAULT_REQUEST_TIMEOUT_SECONDS`
`protected javax.ws.rs.client.WebTarget`	`root`

Constructor Summary

Constructors
Constructor and Description
`PulsarAdmin(String serviceUrl, org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData)`
`PulsarAdmin(String serviceUrl, org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData, int connectTimeout, TimeUnit connectTimeoutUnit, int readTimeout, TimeUnit readTimeoutUnit, int requestTimeout, TimeUnit requestTimeoutUnit, ClassLoader clientBuilderClassLoader)`
`PulsarAdmin(URL serviceUrl, org.apache.pulsar.client.api.Authentication auth)` 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
`Bookies`	`bookies()`
`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()`
`org.apache.pulsar.client.impl.conf.ClientConfigurationData`	`getClientConfigData()`
`String`	`getServiceUrl()`
`Lookup`	`lookups()`
`Namespaces`	`namespaces()`
`NonPersistentTopics`	`nonPersistentTopics()` Deprecated. Since 2.0. See `topics()`
`Properties`	`properties()` Deprecated. since 2.0. See `tenants()`
`ProxyStats`	`proxyStats()`
`ResourceQuotas`	`resourceQuotas()`
`Schemas`	`schemas()`
`Sink`	`sink()` Deprecated. in favor of `sinks`
`Sinks`	`sinks()`
`Source`	`source()` Deprecated. in favor of `sources()`
`Sources`	`sources()`
`Tenants`	`tenants()`
`Topics`	`topics()`
`Worker`	`worker()`

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

- Field Detail
  - DEFAULT_CONNECT_TIMEOUT_SECONDS
```
public static final int DEFAULT_CONNECT_TIMEOUT_SECONDS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_TIMEOUT_SECONDS
```
public static final int DEFAULT_READ_TIMEOUT_SECONDS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REQUEST_TIMEOUT_SECONDS
```
public static final int DEFAULT_REQUEST_TIMEOUT_SECONDS
```
    See Also:
    
    Constant Field Values
  - root
```
protected final javax.ws.rs.client.WebTarget root
```
  - auth
```
protected final org.apache.pulsar.client.api.Authentication auth
```
- Constructor Detail
  - PulsarAdmin
```
public PulsarAdmin(String serviceUrl,
                   org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData)
            throws org.apache.pulsar.client.api.PulsarClientException
```
    Throws:
    
    org.apache.pulsar.client.api.PulsarClientException
  - PulsarAdmin
```
public PulsarAdmin(String serviceUrl,
                   org.apache.pulsar.client.impl.conf.ClientConfigurationData clientConfigData,
                   int connectTimeout,
                   TimeUnit connectTimeoutUnit,
                   int readTimeout,
                   TimeUnit readTimeoutUnit,
                   int requestTimeout,
                   TimeUnit requestTimeoutUnit,
                   ClassLoader clientBuilderClassLoader)
            throws org.apache.pulsar.client.api.PulsarClientException
```
    Throws:
    
    org.apache.pulsar.client.api.PulsarClientException
  - PulsarAdmin
```
@Deprecated
public PulsarAdmin(URL serviceUrl,
                               org.apache.pulsar.client.api.Authentication auth)
                        throws org.apache.pulsar.client.api.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:
    
    org.apache.pulsar.client.api.PulsarClientException
  - PulsarAdmin
```
@Deprecated
public PulsarAdmin(URL serviceUrl,
                               String authPluginClassName,
                               String authParamsString)
                        throws org.apache.pulsar.client.api.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:
    
    org.apache.pulsar.client.api.PulsarClientException
  - PulsarAdmin
```
@Deprecated
public PulsarAdmin(URL serviceUrl,
                               String authPluginClassName,
                               Map<String,String> authParams)
                        throws org.apache.pulsar.client.api.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:
    
    org.apache.pulsar.client.api.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()
```
  - bookies
```
public Bookies bookies()
```
    Returns:
    
    the bookies 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
  - source
```
@Deprecated
public Source source()
```
    Deprecated. in favor of sources()
    
    Returns:
    
    the sources management object
  - sources
```
public Sources sources()
```
  - sink
```
@Deprecated
public Sink sink()
```
    Deprecated. in favor of sinks
    
    Returns:
    
    the sinks management object
  - sinks
```
public Sinks sinks()
```
    Returns:
    
    the sinks management object
  - worker
```
public Worker worker()
```
    Returns:
    
    the Worker stats
  - brokerStats
```
public BrokerStats brokerStats()
```
    Returns:
    
    the broker statics
  - proxyStats
```
public ProxyStats proxyStats()
```
    Returns:
    
    the proxy statics
  - getServiceUrl
```
public String getServiceUrl()
```
    Returns:
    
    the service HTTP URL that is being used
  - getClientConfigData
```
public org.apache.pulsar.client.impl.conf.ClientConfigurationData getClientConfigData()
```
    Returns:
    
    the client Configuration Data that is being used
  - schemas
```
public Schemas schemas()
```
    Returns:
    
    the schemas
  - 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

DEFAULT_CONNECT_TIMEOUT_SECONDS

DEFAULT_READ_TIMEOUT_SECONDS

DEFAULT_REQUEST_TIMEOUT_SECONDS

root

auth

Constructor Detail

PulsarAdmin

PulsarAdmin

PulsarAdmin

PulsarAdmin

PulsarAdmin

Method Detail

builder

clusters

brokers

tenants

properties

namespaces

topics

bookies

nonPersistentTopics

resourceQuotas

lookups

functions

source

sources

sink

sinks

worker

brokerStats

proxyStats

getServiceUrl

getClientConfigData

schemas

close