ClientQuotaEntity (kafka 3.0.2 API)

java.lang.Object

org.apache.kafka.common.quota.ClientQuotaEntity

public class ClientQuotaEntity
extends Object

Describes a client quota entity, which is a mapping of entity types to their names.

Field Summary

Fields

Modifier and Type Field Description

static String CLIENT_ID

static String IP

static String USER
The type of an entity entry.
Constructor Summary

Constructors

Constructor Description

ClientQuotaEntity(Map<String,String> entries)
Constructs a quota entity for the given types and names.

Method Summary

Modifier and Type	Method	Description
`Map<String,String>`	`entries()`
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`static boolean`	`isValidEntityType(String entityType)`
`String`	`toString()`

Methods inherited from class java.lang.Object

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

Field Details
- USER
  
  public static final String USER
  
  The type of an entity entry.
  
  See Also:
  
  Constant Field Values
- CLIENT_ID
  
  public static final String CLIENT_ID
  
  See Also:
  
  Constant Field Values
- IP
  
  public static final String IP
  
  See Also:
  
  Constant Field Values
Constructor Details
- ClientQuotaEntity
  
  public ClientQuotaEntity(Map<String,String> entries)
  
  Constructs a quota entity for the given types and names. If a name is null, then it is mapped to the built-in default entity name.
  
  Parameters:
  
  entries - maps entity type to its name
Method Details
- isValidEntityType
  
  public static boolean isValidEntityType(String entityType)
- entries
  
  public Map<String,String> entries()
  
  Returns:
  
  map of entity type to its 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