/**
 * Describes a client quota entity, which is a mapping of entity types to their names.
 */
public class ClientQuotaEntity {

/**
 * Describes a fully-qualified entity.
 */
public class QuotaEntity {
    /**
     * TypeThe type of an entity entry.
     */
    public enumstatic Typefinal {
String USER       USER,= "user";
    public static final String CLIENT_ID;
    }= "client-id";

    /**
     * RepresentsConstructs thea defaultquota nameentity for the an entity, i.e. the entity that's matchedgiven types and names. If a name is null,
     * when an exact match isn't found then it is mapped to the built-in default entity name.
     */
    public * final@param staticentries String QUOTA_ENTITY_NAME_DEFAULT = // implementation defined

maps entity type to its name
     */**
    public * `entries` describes the fully-qualified entity. The key is a {@code Type} string, however
     * there may also exist keys that are not enumerated by {@code Type} that still apply, e.g.
     * the server may internally associate another type. It's necessary to return all quota typesClientQuotaEntity(Map<String, String> entries);

    /**
     * @return map of entity type to its name
     */
    public Map<String, String> entries();
}

/**
 * Describes a component for applying a client quota filter.
 */
public class ClientQuotaFilterComponent {

    /**
     * Constructs becauseand quotareturns valuesa forfilter thesecomponent typesthat mayexactly influencematches the effective quota value. However,provided entity
     * alteringname afor quota,the anyentity typestype.
 that aren't specified should be*
 able to be inferred by* the
@param entityType the entity type *the server,filter otherwisecomponent an error is returned.applies to
     *
 @param entityName the entity *name For example, {("CLIENT_ID" -> "test-client"),
     *               ("USER" -> "test-user"),
     *        that's matched exactly
     */
    public static ClientQuotaFilterComponent ofEntity(String entityType, String entityName);

    /**
     * Constructs and returns a filter component that matches the built-in default entity name
     * for ("GROUP" -> "internal-group")}the entity type.
     */
    public QuotaEntity(Map<String, String> entries);
}

/**
 * Describes a quota key.
 */
public class QuotaKey { * @param entityType the entity type the filter component applies to
     */
    public static ClientQuotaFilterComponent ofDefaultEntity(String entityType);

    /**
     * TheConstructs quotaand types.
returns a filter component that */
matches any specified name public enum Type {for the
     *   CONSUMER_BYTE_RATE,entity type.
     *
   PRODUCER_BYTE_RATE,
  * @param entityType the entity type REQUEST_PERCENTAGE;
the filter component applies }to

     */**
    public *static TheClientQuotaFilterComponent units for a quota value. Note there may be multiple units for a given quotaofEntityType(String entityType);

    /**
     * @return the component's entity type
     */
   that influencespublic quota behavior.String entityType();

     /**/
    public enum* Units@return {
the optional match string, where:
    RATE_BPS;
 *   }

    /**
  if present, the name that's matched * @param typeexactly
     *         if empty, matches the quotadefault typename
     *       @param units theif unitsnull, formatches theany quotaspecified typename
     */
    public QuotaKey(Type type, Units unitsOptional<String> match();
}

/**
 * Describes a client quota entity filter.
 */
public class QuotaFilterClientQuotaFilter {

    public/**
  enum Rule {
 * A filter to be applied to EXACT,matching client quotas.
  // exact name match*
     * @param components PREFIX;the components to //filter matcheson
 all names with the given* prefix
@param strict whether the }

filter only includes specified /**components
     */
  A  filteringprivate rule to be applied.ClientQuotaFilter(Collection<ClientQuotaFilterComponent> components, boolean strict);

     /**
     * @param entityType the entity type the rule applies to Constructs and returns a quota filter that matches all provided components. Matching entities
     * @paramwith ruleentity thetypes rulethat toare apply
not specified by a component * @param match the non-null string that's applied by the rulewill also be included in the result.
     *
     * @param components the components for the filter
     */
    public QuotaFilter(QuotaEntity.Type entityType, Rule rule, String matchstatic ClientQuotaFilter contains(Collection<ClientQuotaFilterComponent> components);
}

public class DescribeClientQuotasOptions extends AbstractOptions<DescribeClientQuotasOptions> {
    // Empty.
}

    /**
     * MapsThe a collectionresult of entitiesthe to their effective quota values{@link Admin#describeClientQuotas(Collection, DescribeClientQuotasOptions)} call.
 */
public class DescribeClientQuotasResult  *{

     /**
 @param config the quota configuration* forMaps thean requestedentity entities
to its configured   */
    public DescribeEffectiveQuotasResult(Map<QuotaEntity, KafkaFuture<Map<QuotaKey, Value>>> config);

quota value(s). Note if no value is defined for a quota
     /**
     * Returns a map from quota entity to a future which can be used to check the status of the operation.* type for that entity's config, then it is not included in the resulting value map.
     *
     * @param entities future for the collection of entities that matched the filter
     */
    public Map<QuotaEntityDescribeClientQuotasResult(KafkaFuture<Map<ClientQuotaEntity, KafkaFuture<Map<QuotaKeyMap<String, Value>>>Double>>> config(entities);

    /**
     * Returns a future which succeeds only if all quota descriptions succeedmap from quota entity to a future which can be used to check the status of the operation.
     */
    public KafkaFuture<Void> allKafkaFuture<Map<ClientQuotaEntity, Map<String, Double>>> entities();
}

public interface Admin extends AutoCloseable {
    ...

    /**
     * Describes theall effectiveentities quotasmatching for the provided entities.
     * filter that have at least one client quota configuration
     * @paramvalue entitiesdefined.
 the entities to describe the effective quotas for* <p>
     * @paramThe optionsfollowing theexceptions optionscan tobe use
anticipated when calling {@code get()} *on @return the effectivefuture quotas forfrom the entities
     */
 returned {@link DescribeClientQuotasResult}:
 DescribeEffectiveQuotasResult  describeEffectiveQuotas(Collection<QuotaEntity> entities, DescribeEffectiveQuotasOptions* options);
}

public class ResolveClientQuotasOptions extends otherwiseAbstractOptions<ResolveClientQuotasOptions> if{
 null, the existing value is cleared// Empty.
}

/**
 * The result of */
the    public AlterQuotasEntry(QuotaEntity entity, Collection<Op> ops);
}
{@link Admin#resolveClientQuotas(Collection, ResolveClientQuotasOptions)} call.
 */
public class AlterQuotasOptions extends AbstractOptions<AlterQuotasOptions>ResolveClientQuotasResult {
    /**
     * SetsInformation whetherabout thea requestspecific shouldquota be validated without altering the configsconfiguration entry.
     */
    public AlterQuotasOptionsclass validateOnly(boolean validateOnly);
}

Entry {
        /**
 * The result of       * @param source the {@link Admin#alterQuotas(Collection<AlterQuotasEntry>, AlterQuotasOptions)} call.
 *
 * The API of this class is evolving, see {@link Admin} for details.
 */
public class AlterQuotasResult {
entity source for the value
         * @param value the non-null value
         */
        public AlterQuotasResultEntry(Map<QuotaEntityQuotaEntity source, KafkaFuture<Void>>Double futuresvalue);
    }

    /**
     * Returns a map fromInformation about the value for a quota entitytype.
 to a future which can*
 be used to check the* statusNOTE: ofWe themaintain operation.
a `Value` class because additional */
information may be  public Map<QuotaEntity, KafkaFuture<Void>> values();

added, e.g.,
      /**
     * Returns a futurelist whichof succeeds only if all quota alterations succeedoverridden entries.
     */
    public KafkaFuture<Void> all();
}

public interface Admin extends AutoCloseable class Value {
    ...

    /**
     * Alters the quotas as* specified@param forentry the entries.
 quota entry
         */
        public Value(Entry entry);
    }

    /**
     * @paramMaps a alterationscollection theof alterationsentities to perform their resolved quota values.
     *
     * @param @returnconfig the resultquota configuration offor the alterationsrequested entities
     */
    AlterQuotasResultpublic alterQuotasResolveClientQuotasResult(Collection<AlterQuotasEntry>Map<QuotaEntity, entriesKafkaFuture<Map<String, AlterQuotasOptionsValue>>> options);
}

/**
 * Options for {@link Admin#alterClientQuotas(Collection, AlterClientQuotasOptions)}.
 *
 * The API of this class is evolving, see {@link Admin} for details.
 */
public class AlterClientQuotasOptions extends AbstractOptions<AlterClientQuotasOptions> {

    /**
     * Returns whether the request should be validated without altering the configs.
     */
    public boolean validateOnly();

    /**
     * Sets whether the request should be validated without altering the configs.
     */
    public AlterClientQuotasOptions validateOnly(boolean validateOnly);
}

/**
 * The result of the {@link Admin#alterClientQuotas(Collection, AlterClientQuotasOptions)} call.
 *
 * The API of this class is evolving, see {@link Admin} for details.
 */
@InterfaceStability.Evolving
public class AlterClientQuotasResult {

    /**
     * Maps an entity to its alteration result.
     *
     * @param futures maps entity to its alteration result
     */
    public AlterClientQuotasResult(Map<ClientQuotaEntity, KafkaFuture<Void>> futures);

    /**
     * Returns a map from quota entity to a future which can be used to check the status of the operation.
     */
    public Map<ClientQuotaEntity, KafkaFuture<Void>> values();

    /**
     * Returns a future which succeeds only if all quota alterations succeed.
     */
    public KafkaFuture<Void> all();
}

public interface Admin extends AutoCloseable {
    ...

    /**
     * Alters client quota configurations with the specified alterations.
     * <p>
     * Alterations for a single entity are atomic, but across entities is not guaranteed. The resulting
     * per-entity error code should be evaluated to resolve the success or failure of all updates.
     * <p>
     * The following exceptions can be anticipated when calling {@code get()} on the futures obtained from
     * the returned {@link AlterClientQuotasResult}:
     * <ul>
     *   <li>{@link org.apache.kafka.common.errors.ClusterAuthorizationException}
     *   If the authenticated user didn't have alter access to the cluster.</li>
     *   <li>{@link org.apache.kafka.common.errors.InvalidRequestException}
     *   If the request details are invalid. e.g., a configuration key was specified more than once for an entity.</li>
     *   <li>{@link org.apache.kafka.common.errors.TimeoutException}
     *   If the request timed out before the alterations could finish. It cannot be guaranteed whether the update
     *   succeed or not.</li>
     * </ul>
     * <p>
     * This operation is supported by brokers with version 2.6.0 or higher.
     *
     * @param entries the alterations to perform
     * @return the AlterClientQuotasResult containing the result
     */
    AlterClientQuotasResult alterClientQuotas(Collection<ClientQuotaAlteration> entries, AlterClientQuotasOptions options);
}

$./bin/kafka-client-quotas.sh --bootstrap-server localhost:9092 --describe \
                              --names=client-id=my-client

{user=user-one, client-id=my-client}
consumer_byte_rate=4000000
producer_byte_rate=1000000

{user=user-two, client-id=my-client}
producer_byte_rate=2000000

{user=<default>, client-id=my-client}
consumer_byte_rate=1000000
producer_byte_rate=500000

$./bin/kafka-client-quotas.sh --bootstrap-server localhost:9092 --resolve \
                              --names=user=user-two,client-id=my-client

consumer_byte_rate=2000000 {user=user-two, client-id=my-client}
producer_byte_rate=500000 {user=<default>, client-id=my-client}

$./bin/kafka-client-quotas.sh --bootstrap-server localhost:9092 --alter   \
                              --names=client-id=my-client --defaults=user \
                              --add=consumer_byte_rate=2000000            \
                              --delete=producer_byte_rate

<no output on success>

$./bin/kafka-client-quotas.sh --bootstrap-server localhost:9092 --describe \
                              --names=client-id=my-client --defaults=user

{user=<default>, client-id=my-client}
consumer_byte_rate=2000000

{
  "apiKey": 48,
  "type": "request",
  "name": "DescribeClientQuotasRequest",
  "validVersions": "0",
  "flexibleVersions": "none",
  "fields": [
    { "name": "Components", "type": "[]ComponentData", "versions": "0+",
      "about": "Filter components to apply to quota entities.", "fields": [
      { "name": "EntityType", "type": "string", "versions": "0+",
        "about": "The entity type that the filter component applies to." },
      { "name": "MatchType", "type": "int8", "versions": "0+",
        "about": "How to match the entity {0 = exact name, 1 = default name, 2 = any specified name}." },
      { "name": "Match", "type": "string", "versions": "0+", "nullableVersions": "0+",
        "about": "The string to match against, or null if unused for the match type." }
    ]},
    { "name": "Strict", "type": "bool", "versions": "0+",
      "about": "Whether the match is strict, i.e. should exclude entities with unspecified entity types." }
  ]
}

{
  "apiKey": 48,
  "type": "response",
  "name": "DescribeClientQuotasResponse",
  "validVersions": "0",
  "flexibleVersions": "none",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
    { "name": "ErrorCode", "type": "int16", "versions": "0+",
      "about": "The error code, or `0` if the quota description succeeded." },
    { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+",
      "about": "The error message, or `null` if the quota description succeeded." },
    { "name": "Entries", "type": "[]EntryData", "versions": "0+", "nullableVersions": "0+",
      "about": "A result entry.", "fields": [
      { "name": "Entity", "type": "[]EntityData", "versions": "0+",
        "about": "The quota entity description.", "fields": [
        { "name": "EntityType", "type": "string", "versions": "0+",
          "about": "The entity type." },
        { "name": "EntityName", "type": "string", "versions": "0+", "nullableVersions": "0+",
          "about": "The entity name, or null if the default." }
      ]},
      { "name": "Values", "type": "[]ValueData", "versions": "0+",
	"about": "The quota values for the entity.", "fields": [
        { "name": "Key", "type": "string", "versions": "0+",
          "about": "The quota configuration key." },
        { "name": "Value", "type": "float64", "versions": "0+",
          "about": "The quota configuration value." }
      ]}
    ]}
  ]
}

{
  "apiKey": 49,
  "type": "responserequest",
  "name": "DescribeEffectiveQuotasResponseAlterClientQuotasRequest",
  "validVersions": "0",
  "flexibleVersions": "none",
  "fields": [
    { "name": "ThrottleTimeMsEntries", "type": "int32[]EntryData", "versions": "0+",
      "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
 quota configuration entries to alter.", "fields": [
      { "name": "Entity", "type": "[]EntityData", "versions": "0+",
        "about": "The quota entity to alter.", "fields": [
        { "name": "EntryEntityType", "type": "[]QuotaEntryDatastring", "versions": "0+",
          "about": "EffectiveThe quotaentity entriestype." },
 "fields": [
      { "name": "ErrorCodeEntityName", "type": "int16string", "versions": "0+", "nullableVersions": "0+",
          "about": "The error codename of the entity, or `0`null if the effective quota description succeeded." default." }
      ]},
      { "name": "ErrorMessageOps", "type": "string[]OpData", "versions": "0+", "nullableVersions": "0+",
        "about": "TheAn errorindividual message,quota orconfiguration `null`entry if the effective quota description succeeded." },
to alter.", "fields": [
        { "name": "QuotaEntityKey", "type": "[]QuotaEntitystring", "versions": "0+",
          "about": "EffectiveThe quota entriesconfiguration key.", "fields": [ },
        { "name": "EntityTypeValue", "type": "stringfloat64", "versions": "0+",
          "about": "The entity type value to set, otherwise ignored if the value is to be removed." },
        { "name": "EntityNameRemove", "type": "stringbool", "versions": "0+",
          "about": "The entity nameWhether the quota configuration value should be removed, otherwise set." }
      ]},
    ]},
    { "name": "QuotaValuesValidateOnly", "type": "[]QuotaValueDatabool", "versions": "0+",
        "about": "Quota configuration values.", "fields": [
        { "nameWhether the alteration should be validated, but not performed." }
  ]
}

{
  "apiKey": 49,
  "type": "Typeresponse",
  "typename": "stringAlterClientQuotasResponse",
  "versionsvalidVersions": "0+",
          "aboutflexibleVersions": "The quota type." }none",
  "fields": [
     { "name": "UnitsThrottleTimeMs", "type": "stringint32", "versions": "0+",
          "about": "The unitsduration in milliseconds for which the request was throttled due to a quota type violation, or zero if the request did not violate any quota." },
        { "name": "EntryEntries", "type": "[]ValueEntryDataEntryData", "versions": "0+",
          "about": "QuotaThe quota valueconfiguration entries to alter.", "fields": [
          { "name": "QuotaEntityErrorCode", "type": "[]ValueQuotaEntityint16", "versions": "0+",
            "about": "EffectiveThe quotaerror entries."code, "fields": [
      or `0` if the quota alteration succeeded." },
      { "name": "EntityTypeErrorMessage", "type": "string", "versions": "0+",
      "nullableVersions": "0+",
        "about": "The error entity type." },
      message, or `null` if the quota alteration succeeded." },
      { "name": "EntityNameEntity", "type": "string[]EntityData", "versions": "0+",
              "about": "The quota entity nameto alter." }
          ]},
 , "fields": [
         { "name": "ValueEntityType", "type": "int64string", "versions": "0+",
            "about": "The quotaentity configuration valuetype." },
        ]}
      ]}
    ]}
  ]
}

    /**
     * Read  "about": "The quota entity to alter.", "fields": [a double-precision 64-bit format IEEE 754 value.
     *
   { "name": "EntityType", "type": "string", "versions": "0+",
    * @param buffer The buffer to read from
     * @return "about": "The entitylong type." },value read
     */
   { "name": "EntityName", "type": "string", "versions": "0+",public static double readDouble(ByteBuffer buffer) {
        return  "about": "The name of the entity." }
Double.longBitsToDouble(buffer.getLong());
    }

    /**
     * Write ]},
the given double following the  { "name": "Op", "type": "[]OpData", "versions": "0+",
double-precision 64-bit format IEEE 754 value into the buffer.
     *
    "about": "An individual quota configuration entry to alter.", "fields": [
        { "name": "Type", "type": "string", "versions": "0+", * @param value The value to write
     * @param buffer The buffer to write to
     */
    public static void writeDouble(double value,  "about": "The quota type." },ByteBuffer buffer) {
        buffer.putLong(Double.doubleToRawLongBits(value));
    }

    { "name": "Units", "type": "string", "versions": "0+",
  public static final DocumentedType DOUBLE = new DocumentedType() {
        "about": "The units for the quota type." },
        { "name": "Value", "type": "int64", "versions": "0+",
@Override
        public void write(ByteBuffer buffer, Object o) {
            ByteUtils.writeDouble((Double) o, buffer);
  "about": "The value to set, otherwise ignored}

 if the value is to be removed." },@Override
        { "name": "Remove", "type": "bool", "versions": "0+",public Object read(ByteBuffer buffer) {
          "about": "Whether the quota configuration value should be removed, otherwise set."return ByteUtils.readDouble(buffer);
        }

      ]}
  @Override
  ]},
    { "name": "ValidateOnly", "type": "bool", "versions": "0+", public int sizeOf(Object o) {
      "about": "Whether the alteration should be validated, but not performed." }return 8;
  ]
}

{
  "apiKey": 50,
  "type": "response", }

  "name": "AlterQuotasResponse",
  "validVersions": "0",
  "flexibleVersions": "none",
  "fields": [
    { "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      @Override
        public String typeName() {
            return "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
    { "name": "Entry", "type": "[]EntryData", "versions": "0+",
DOUBLE";
        }

        @Override
        public Double validate(Object item) {
             "about": "The quota configuration entries to alter.", "fields": [
if (item instanceof Double)
            { "name": "ErrorCode", "type": "int16", "versions": "0+", return (Double) item;
        "about": "The error code, orelse
 `0` if the quota alteration succeeded." },
      { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+", throw new SchemaException(item + " is not a Double.");
        "about": "The error message, or `null` if the quota alteration succeeded." },
      { "name": "QuotaEntity", "type": "[]QuotaEntity", "versions": "0+",
}

        @Override
        public String documentation() {
            return "Represents  "about": "The quota entity to alter.", "fields": [
a double-precision 64-bit format IEEE 754 value. " +
         { "name": "EntityType", "type": "string", "versions": "0+",
          "about": "The entity type." },           "The values are encoded using eight bytes in network byte order (big-endian).";
        { "name": "EntityName", "type": "string", "versions": "0+",
          "about": "The name of the entity." }
      ]}
    ]}
  ]
}

Hash code: Double.hashCode(value)

Empty value: (double) 0

Parsing a default value string: Double.parseDouble(defaultValue)