Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejs
{
  "apiKey": 48,
  "type": "response",
  "name": "DescribeClientQuotasResponse",
  // Version 1 enables flexible versions.
  // Version 2 adds support for batching.
  "validVersions": "0-2",
  "flexibleVersions": "1+",
  "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-1",
      "about": "The error code, or `0` if the quota description succeeded." },
    { "name": "ErrorMessage", "type": "string", "versions": "0-1", "nullableVersions": "0-1",
      "about": "The error message, or `null` if the quota description succeeded." },
    { "name": "Entries", "type": "[]OldEntryData", "versions": "0-1", "nullableVersions": "0-1",
      "about": "A result entry.", "fields": [
      { "name": "Entity", "type": "[]OldEntityData", "versions": "0-1",
        "about": "The quota entity description.", "fields": [
        { "name": "EntityType", "type": "string", "versions": "0-1",
          "about": "The entity type." },
        { "name": "EntityName", "type": "string", "versions": "0-1", "nullableVersions": "0-1",
          "about": "The entity name, or null if the default." }
      ]},
      { "name": "Values", "type": "[]OldValueData", "versions": "0-1",
	"about": "The quota values for the entity.", "fields": [
        { "name": "Key", "type": "string", "versions": "0-1",
          "about": "The quota configuration key." },
        { "name": "Value", "type": "float64", "versions": "0-1",
          "about": "The quota configuration value." }
      ]}
    ]},
    {
      "name": "FilterResults",
      "type": "[]DescribeClientQuotasFilterResult",
      "versions": "2+",
      "about": "The results for each filter.",
      "fields": [
        { "name": "ErrorCode", "type": "int16", "versions": "2+",
          "about": "The error code, or `0` if the quota description succeeded." },
        { "name": "ErrorMessage", "type": "string", "versions": "2+", "nullableVersions": "2+",
          "about": "The error message, or `null` if the quota description succeeded." },
        { "name": "Entries", "type": "[]EntryData", "versions": "2+", "nullableVersions": "2+",
          "about": "A result entry.", "fields": [
          { "name": "Entity", "type": "[]EntityData", "versions": "2+",
            "about": "The quota entity description.", "fields": [
            { "name": "EntityType", "type": "string", "versions": "2+",
              "about": "The entity type." },
            { "name": "EntityName", "type": "string", "versions": "2+", "nullableVersions": "2+",
              "about": "The entity name, or null if the default." }
          ]},
          { "name": "Values", "type": "[]ValueData", "versions": "2+",
            "about": "The quota values for the entity.", "fields": [
            { "name": "Key", "type": "string", "versions": "2+",
              "about": "The quota configuration key." },
            { "name": "Value", "type": "float64", "versions": "2+",
              "about": "The quota configuration value." }
          ]}
        ]}
      ]
    }
  ]
}


3) New Admin APIs
Two new methods will be added to the Admin interface:

Code Block
languagejava
    /**
     * This is a convenience method for {@link #describeAcls(Collection<AclBindingFilter>, DescribeAclsOptions)} with
     * default options. See the overload for more details.
     * <p>
     *
     * @param filters The filter to use.
     * @return The DescribeAclsResult.
     */
    default DescribeAclsResult describeAcls(Collection<AclBindingFilter> filters) {
        return describeAcls(filters, new DescribeAclsOptions());
    }

    /**
     * Lists access control lists (ACLs) according to the supplied filters.
     * <p>
     * Note: it may take some time for changes made by {@code createAcls} or {@code deleteAcls} to be reflected
     * in the output of {@code describeAcls}.
     * <p>
     *
     * @param filters  The filters to use.
     * @param options The options to use when listing the ACLs.
     * @return The DescribeAclsResult.
     */
    DescribeAclsResult describeAcls(Collection<AclBindingFilter> filters, DescribeAclsOptions options);


Proposed Changes

Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.

...