Package org.apache.pulsar.common.policies.data

Interface BacklogQuota

All Known Implementing Classes:

BacklogQuotaImpl

public interface BacklogQuota

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	Interface	Description
static enum	BacklogQuota.BacklogQuotaType	Identifier to a backlog quota configuration (an instance of BacklogQuota).
static interface	BacklogQuota.Builder
static enum	BacklogQuota.RetentionPolicy	Enumeration type determines how to retain backlog against the resource shortages.

Method Summary

Modifier and Type	Method	Description
static BacklogQuota.Builder	builder()
long	getLimit()	Deprecated.
long	getLimitSize()	Gets quota limit in size.
int	getLimitTime()	Gets quota limit in time.
BacklogQuota.RetentionPolicy	getPolicy()
default void	validate()

Method Details

getLimit

@Deprecated
long getLimit()

Deprecated.

Gets quota limit in size. Remains for compatible

Returns:

quota limit in bytes

getLimitSize

long getLimitSize()

Gets quota limit in size.

Returns:

quota limit in bytes

getLimitTime

int getLimitTime()

Gets quota limit in time.

Returns:

quota limit in second

getPolicy

BacklogQuota.RetentionPolicy getPolicy()

builder

static BacklogQuota.Builder builder()

validate

default void validate()