org.apache.kafka.common.quota

Class ClientQuotaFilterComponent

java.lang.Object

org.apache.kafka.common.quota.ClientQuotaFilterComponent

public class ClientQuotaFilterComponent
extends Object

Describes a component for applying a client quota filter.

Method Summary

Modifier and Type	Method and Description
String	entityType()
boolean	equals(Object o)
int	hashCode()
Optional<String>	match()
static ClientQuotaFilterComponent	ofDefaultEntity(String entityType) Constructs and returns a filter component that matches the built-in default entity name for the entity type.
static ClientQuotaFilterComponent	ofEntity(String entityType, String entityName) Constructs and returns a filter component that exactly matches the provided entity name for the entity type.
static ClientQuotaFilterComponent	ofEntityType(String entityType) Constructs and returns a filter component that matches any specified name for the entity type.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

ofEntity

public static ClientQuotaFilterComponent ofEntity(String entityType,
                                                  String entityName)

Constructs and returns a filter component that exactly matches the provided entity name for the entity type.

Parameters:

entityType - the entity type the filter component applies to

entityName - the entity name that's matched exactly

ofDefaultEntity

public static ClientQuotaFilterComponent ofDefaultEntity(String entityType)

Constructs and returns a filter component that matches the built-in default entity name for the entity type.

Parameters:

entityType - the entity type the filter component applies to

ofEntityType

public static ClientQuotaFilterComponent ofEntityType(String entityType)

Constructs and returns a filter component that matches any specified name for the entity type.

Parameters:

entityType - the entity type the filter component applies to

entityType

public String entityType()

Returns:

the component's entity type

match

public Optional<String> match()

Returns:

the optional match string, where: if present, the name that's matched exactly if empty, matches the default name if null, matches any specified name

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