Package org.apache.kafka.common.quota

Class ClientQuotaFilter

java.lang.Object

org.apache.kafka.common.quota.ClientQuotaFilter

public class ClientQuotaFilter
extends Object

Describes a client quota entity filter.

Method Summary

Modifier and Type	Method	Description
static ClientQuotaFilter	all()	Constructs and returns a quota filter that matches all configured entities.
Collection<ClientQuotaFilterComponent>	components()
static ClientQuotaFilter	contains(Collection<ClientQuotaFilterComponent> components)	Constructs and returns a quota filter that matches all provided components.
static ClientQuotaFilter	containsOnly(Collection<ClientQuotaFilterComponent> components)	Constructs and returns a quota filter that matches all provided components.
boolean	equals(Object o)
int	hashCode()
boolean	strict()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

contains

public static ClientQuotaFilter contains(Collection<ClientQuotaFilterComponent> components)

Constructs and returns a quota filter that matches all provided components. Matching entities with entity types that are not specified by a component will also be included in the result.

Parameters:

components - the components for the filter

containsOnly

public static ClientQuotaFilter containsOnly(Collection<ClientQuotaFilterComponent> components)

Constructs and returns a quota filter that matches all provided components. Matching entities with entity types that are not specified by a component will *not* be included in the result.

Parameters:

components - the components for the filter

all

public static ClientQuotaFilter all()

Constructs and returns a quota filter that matches all configured entities.

components

public Collection<ClientQuotaFilterComponent> components()

Returns:

the filter's components

strict

public boolean strict()

Returns:

whether the filter is strict, i.e. only includes specified components

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object