org.apache.pulsar.common.policies.data

Class BacklogQuota

java.lang.Object

org.apache.pulsar.common.policies.data.BacklogQuota

public class BacklogQuota
extends Object

Unit of a backlog quota configuration for a scoped resource in a Pulsar instance.

A scoped resource is identified by a BacklogQuota.BacklogQuotaType enumeration type which is containing two attributes: limit representing a quota limit in bytes and policy for backlog retention policy.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BacklogQuota.BacklogQuotaType Identifier to a backlog quota configuration (an instance of BacklogQuota).
static class	BacklogQuota.RetentionPolicy Enumeration type determines how to retain backlog against the resource shortages.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BacklogQuota()
	BacklogQuota(long limit, BacklogQuota.RetentionPolicy policy)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
long	getLimit() Gets quota limit in bytes.
BacklogQuota.RetentionPolicy	getPolicy()
int	hashCode()
void	setLimit(long limit) Sets quota limit in bytes.
void	setPolicy(BacklogQuota.RetentionPolicy policy)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BacklogQuota

protected BacklogQuota()

BacklogQuota

public BacklogQuota(long limit,
                    BacklogQuota.RetentionPolicy policy)

Method Detail

getLimit

public long getLimit()

Gets quota limit in bytes.

Returns:

quota limit in bytes

getPolicy

public BacklogQuota.RetentionPolicy getPolicy()

setLimit

public void setLimit(long limit)

Sets quota limit in bytes.

Parameters:

limit - quota limit in bytes

setPolicy

public void setPolicy(BacklogQuota.RetentionPolicy policy)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object