LoadReport (Pulsar Common 2.10.0-rc-202203222205 API)

java.lang.Object
- org.apache.pulsar.policies.data.loadbalancer.LoadReport

All Implemented Interfaces:

LoadManagerReport, ServiceLookupData
```
public class LoadReport
extends Object
implements LoadManagerReport
```
This class represents the overall load of the broker - it includes overall SystemResourceUsage and NamespaceUsage for all the namespaces hosted by this broker.

Field Summary

Fields
Modifier and Type Field and Description

static String loadReportType

Fields
Modifier and Type	Field and Description
`static String`	`loadReportType`

Constructor Summary

Constructors
Constructor and Description
`LoadReport()`
`LoadReport(String webServiceUrl, String webServiceUrlTls, String pulsarServiceUrl, String pulsarServiceUrlTls)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getAllocatedBandwidthIn()`
`double`	`getAllocatedBandwidthOut()`
`double`	`getAllocatedCPU()`
`double`	`getAllocatedMemory()`
`double`	`getAllocatedMsgRateIn()`
`double`	`getAllocatedMsgRateOut()`
`ResourceUsage`	`getBandwidthIn()`
`ResourceUsage`	`getBandwidthOut()`
`SystemResourceUsage.ResourceType`	`getBottleneckResourceType()`
`String`	`getBrokerVersionString()`
`Set<String>`	`getBundleGains()`
`Set<String>`	`getBundleLosses()`
`Set<String>`	`getBundles()`
`Map<String,NamespaceBundleStats>`	`getBundleStats()`
`ResourceUsage`	`getCpu()`
`ResourceUsage`	`getDirectMemory()`
`long`	`getLastUpdate()`
`String`	`getLoadReportType()`
`ResourceUsage`	`getMemory()`
`double`	`getMsgRateIn()`
`double`	`getMsgRateOut()`
`double`	`getMsgThroughputIn()`
`double`	`getMsgThroughputOut()`
`String`	`getName()`
`int`	`getNumBundles()`
`int`	`getNumConsumers()`
`int`	`getNumProducers()`
`int`	`getNumTopics()`
`double`	`getPreAllocatedBandwidthIn()`
`double`	`getPreAllocatedBandwidthOut()`
`double`	`getPreAllocatedCPU()`
`double`	`getPreAllocatedMemory()`
`double`	`getPreAllocatedMsgRateIn()`
`double`	`getPreAllocatedMsgRateOut()`
`Optional<String>`	`getProtocol(String protocol)`
`Map<String,String>`	`getProtocols()`
`String`	`getPulsarServiceUrl()`
`String`	`getPulsarServiceUrlTls()`
`TreeMap<String,NamespaceBundleStats>`	`getSortedBundleStats(SystemResourceUsage.ResourceType resType)`
`SystemResourceUsage`	`getSystemResourceUsage()`
`long`	`getTimestamp()`
`String`	`getWebServiceUrl()`
`String`	`getWebServiceUrlTls()`
`boolean`	`isNonPersistentTopicsEnabled()`
`boolean`	`isOverLoaded()`
`boolean`	`isPersistentTopicsEnabled()`
`boolean`	`isUnderLoaded()`
`void`	`setAllocatedBandwidthIn(double allocatedBandwidthIn)`
`void`	`setAllocatedBandwidthOut(double allocatedBandwidthOut)`
`void`	`setAllocatedCPU(double allocatedCPU)`
`void`	`setAllocatedMemory(double allocatedMemory)`
`void`	`setAllocatedMsgRateIn(double allocatedMsgRateIn)`
`void`	`setAllocatedMsgRateOut(double allocatedMsgRateOut)`
`void`	`setBrokerVersionString(String brokerVersionString)`
`void`	`setBundleGains(Set<String> bundleGains)`
`void`	`setBundleLosses(Set<String> bundleLosses)`
`void`	`setBundleStats(Map<String,NamespaceBundleStats> stats)`
`void`	`setName(String brokerName)`
`void`	`setNonPersistentTopicsEnabled(boolean nonPersistentTopicsEnabled)`
`void`	`setOverLoaded(boolean isOverLoaded)`
`void`	`setPersistentTopicsEnabled(boolean persistentTopicsEnabled)`
`void`	`setPreAllocatedBandwidthIn(double preAllocatedBandwidthIn)`
`void`	`setPreAllocatedBandwidthOut(double preAllocatedBandwidthOut)`
`void`	`setPreAllocatedCPU(double preAllocatedCPU)`
`void`	`setPreAllocatedMemory(double preAllocatedMemory)`
`void`	`setPreAllocatedMsgRateIn(double preAllocatedMsgRateIn)`
`void`	`setPreAllocatedMsgRateOut(double preAllocatedMsgRateOut)`
`void`	`setProtocols(Map<String,String> protocols)`
`void`	`setSystemResourceUsage(SystemResourceUsage systemResourceUsage)`
`void`	`setTimestamp(long timestamp)`
`void`	`setUnderLoaded(boolean isUnderLoaded)`

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

Field Detail

loadReportType

public static final String loadReportType

Constructor Detail

LoadReport
```
public LoadReport()
```

LoadReport

public LoadReport(String webServiceUrl,
                  String webServiceUrlTls,
                  String pulsarServiceUrl,
                  String pulsarServiceUrlTls)

Method Detail

setBundleStats

public void setBundleStats(Map<String,NamespaceBundleStats> stats)

getBundleStats
```
public Map<String,NamespaceBundleStats> getBundleStats()
```
Specified by:

getBundleStats in interface LoadManagerReport

getName
```
public String getName()
```

setName

public void setName(String brokerName)

getSystemResourceUsage

public SystemResourceUsage getSystemResourceUsage()

setSystemResourceUsage

public void setSystemResourceUsage(SystemResourceUsage systemResourceUsage)

isUnderLoaded
```
public boolean isUnderLoaded()
```

setUnderLoaded

public void setUnderLoaded(boolean isUnderLoaded)

isOverLoaded
```
public boolean isOverLoaded()
```

getBottleneckResourceType

public SystemResourceUsage.ResourceType getBottleneckResourceType()

setOverLoaded

public void setOverLoaded(boolean isOverLoaded)

getTimestamp
```
public long getTimestamp()
```

setTimestamp

public void setTimestamp(long timestamp)

getMsgRateIn
```
public double getMsgRateIn()
```
Specified by:

getMsgRateIn in interface LoadManagerReport

getMsgRateOut
```
public double getMsgRateOut()
```
Specified by:

getMsgRateOut in interface LoadManagerReport

getLoadReportType
```
public String getLoadReportType()
```

getNumTopics
```
public int getNumTopics()
```
Specified by:

getNumTopics in interface LoadManagerReport

getNumConsumers
```
public int getNumConsumers()
```
Specified by:

getNumConsumers in interface LoadManagerReport

getNumProducers
```
public int getNumProducers()
```
Specified by:

getNumProducers in interface LoadManagerReport

getNumBundles
```
public int getNumBundles()
```
Specified by:

getNumBundles in interface LoadManagerReport

getBundles
```
public Set<String> getBundles()
```

getSortedBundleStats

public TreeMap<String,NamespaceBundleStats> getSortedBundleStats(SystemResourceUsage.ResourceType resType)

getBundleGains
```
public Set<String> getBundleGains()
```

setBundleGains

public void setBundleGains(Set<String> bundleGains)

getBundleLosses
```
public Set<String> getBundleLosses()
```

setBundleLosses

public void setBundleLosses(Set<String> bundleLosses)

getAllocatedCPU
```
public double getAllocatedCPU()
```

setAllocatedCPU

public void setAllocatedCPU(double allocatedCPU)

getAllocatedMemory
```
public double getAllocatedMemory()
```

setAllocatedMemory

public void setAllocatedMemory(double allocatedMemory)

getAllocatedBandwidthIn

public double getAllocatedBandwidthIn()

setAllocatedBandwidthIn

public void setAllocatedBandwidthIn(double allocatedBandwidthIn)

getAllocatedBandwidthOut

public double getAllocatedBandwidthOut()

setAllocatedBandwidthOut

public void setAllocatedBandwidthOut(double allocatedBandwidthOut)

getAllocatedMsgRateIn
```
public double getAllocatedMsgRateIn()
```

setAllocatedMsgRateIn

public void setAllocatedMsgRateIn(double allocatedMsgRateIn)

getAllocatedMsgRateOut

public double getAllocatedMsgRateOut()

setAllocatedMsgRateOut

public void setAllocatedMsgRateOut(double allocatedMsgRateOut)

getPreAllocatedCPU
```
public double getPreAllocatedCPU()
```

setPreAllocatedCPU

public void setPreAllocatedCPU(double preAllocatedCPU)

getPreAllocatedMemory
```
public double getPreAllocatedMemory()
```

setPreAllocatedMemory

public void setPreAllocatedMemory(double preAllocatedMemory)

getPreAllocatedBandwidthIn

public double getPreAllocatedBandwidthIn()

setPreAllocatedBandwidthIn

public void setPreAllocatedBandwidthIn(double preAllocatedBandwidthIn)

getPreAllocatedBandwidthOut

public double getPreAllocatedBandwidthOut()

setPreAllocatedBandwidthOut

public void setPreAllocatedBandwidthOut(double preAllocatedBandwidthOut)

getPreAllocatedMsgRateIn

public double getPreAllocatedMsgRateIn()

setPreAllocatedMsgRateIn

public void setPreAllocatedMsgRateIn(double preAllocatedMsgRateIn)

getPreAllocatedMsgRateOut

public double getPreAllocatedMsgRateOut()

setPreAllocatedMsgRateOut

public void setPreAllocatedMsgRateOut(double preAllocatedMsgRateOut)

setBrokerVersionString

public void setBrokerVersionString(String brokerVersionString)

getBrokerVersionString
```
public String getBrokerVersionString()
```
Specified by:

getBrokerVersionString in interface LoadManagerReport

getWebServiceUrl
```
public String getWebServiceUrl()
```
Specified by:

getWebServiceUrl in interface ServiceLookupData

getWebServiceUrlTls
```
public String getWebServiceUrlTls()
```
Specified by:

getWebServiceUrlTls in interface ServiceLookupData

getPulsarServiceUrl
```
public String getPulsarServiceUrl()
```
Specified by:

getPulsarServiceUrl in interface ServiceLookupData

getPulsarServiceUrlTls
```
public String getPulsarServiceUrlTls()
```
Specified by:

getPulsarServiceUrlTls in interface ServiceLookupData

isPersistentTopicsEnabled
```
public boolean isPersistentTopicsEnabled()
```
Specified by:

isPersistentTopicsEnabled in interface LoadManagerReport

setPersistentTopicsEnabled

public void setPersistentTopicsEnabled(boolean persistentTopicsEnabled)

isNonPersistentTopicsEnabled
```
public boolean isNonPersistentTopicsEnabled()
```
Specified by:

isNonPersistentTopicsEnabled in interface LoadManagerReport

setNonPersistentTopicsEnabled

public void setNonPersistentTopicsEnabled(boolean nonPersistentTopicsEnabled)

getCpu
```
public ResourceUsage getCpu()
```
Specified by:

getCpu in interface LoadManagerReport

getMemory
```
public ResourceUsage getMemory()
```
Specified by:

getMemory in interface LoadManagerReport

getDirectMemory
```
public ResourceUsage getDirectMemory()
```
Specified by:

getDirectMemory in interface LoadManagerReport

getBandwidthIn
```
public ResourceUsage getBandwidthIn()
```
Specified by:

getBandwidthIn in interface LoadManagerReport

getBandwidthOut
```
public ResourceUsage getBandwidthOut()
```
Specified by:

getBandwidthOut in interface LoadManagerReport

getLastUpdate
```
public long getLastUpdate()
```
Specified by:

getLastUpdate in interface LoadManagerReport

getMsgThroughputIn
```
public double getMsgThroughputIn()
```
Specified by:

getMsgThroughputIn in interface LoadManagerReport

getMsgThroughputOut
```
public double getMsgThroughputOut()
```
Specified by:

getMsgThroughputOut in interface LoadManagerReport

getProtocols
```
public Map<String,String> getProtocols()
```
Specified by:

getProtocols in interface ServiceLookupData

setProtocols

public void setProtocols(Map<String,String> protocols)

getProtocol
```
public Optional<String> getProtocol(String protocol)
```
Specified by:

getProtocol in interface ServiceLookupData

Class LoadReport

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

loadReportType

Constructor Detail

LoadReport

LoadReport

Method Detail

setBundleStats

getBundleStats

getName

setName

getSystemResourceUsage

setSystemResourceUsage

isUnderLoaded

setUnderLoaded

isOverLoaded

getBottleneckResourceType

setOverLoaded

getTimestamp

setTimestamp

getMsgRateIn

getMsgRateOut

getLoadReportType

getNumTopics

getNumConsumers

getNumProducers

getNumBundles

getBundles

getSortedBundleStats

getBundleGains

setBundleGains

getBundleLosses

setBundleLosses

getAllocatedCPU

setAllocatedCPU

getAllocatedMemory

setAllocatedMemory

getAllocatedBandwidthIn

setAllocatedBandwidthIn

getAllocatedBandwidthOut

setAllocatedBandwidthOut

getAllocatedMsgRateIn

setAllocatedMsgRateIn

getAllocatedMsgRateOut

setAllocatedMsgRateOut

getPreAllocatedCPU

setPreAllocatedCPU

getPreAllocatedMemory

setPreAllocatedMemory

getPreAllocatedBandwidthIn

setPreAllocatedBandwidthIn

getPreAllocatedBandwidthOut

setPreAllocatedBandwidthOut

getPreAllocatedMsgRateIn

setPreAllocatedMsgRateIn

getPreAllocatedMsgRateOut

setPreAllocatedMsgRateOut

setBrokerVersionString

getBrokerVersionString

getWebServiceUrl

getWebServiceUrlTls

getPulsarServiceUrl

getPulsarServiceUrlTls

isPersistentTopicsEnabled

setPersistentTopicsEnabled

isNonPersistentTopicsEnabled

setNonPersistentTopicsEnabled

getCpu

getMemory

getDirectMemory

getBandwidthIn

getBandwidthOut

getLastUpdate

getMsgThroughputIn

getMsgThroughputOut

getProtocols