mirror of
https://github.com/didi/KnowStreaming.git
synced 2026-01-03 11:28:12 +08:00
67 lines
3.7 KiB
JSON
67 lines
3.7 KiB
JSON
// Licensed to the Apache Software Foundation (ASF) under one or more
|
|
// contributor license agreements. See the NOTICE file distributed with
|
|
// this work for additional information regarding copyright ownership.
|
|
// The ASF licenses this file to You under the Apache License, Version 2.0
|
|
// (the "License"); you may not use this file except in compliance with
|
|
// the License. You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
{
|
|
"apiKey": 32,
|
|
"type": "response",
|
|
"name": "DescribeConfigsResponse",
|
|
// Version 1 adds ConfigSource and the synonyms.
|
|
// Starting in version 2, on quota violation, brokers send out responses before throttling.
|
|
"validVersions": "0-2",
|
|
"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": "Results", "type": "[]DescribeConfigsResult", "versions": "0+",
|
|
"about": "The results for each resource.", "fields": [
|
|
{ "name": "ErrorCode", "type": "int16", "versions": "0+",
|
|
"about": "The error code, or 0 if we were able to successfully describe the configurations." },
|
|
{ "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+",
|
|
"about": "The error message, or null if we were able to successfully describe the configurations." },
|
|
{ "name": "ResourceType", "type": "int8", "versions": "0+",
|
|
"about": "The resource type." },
|
|
{ "name": "ResourceName", "type": "string", "versions": "0+",
|
|
"about": "The resource name." },
|
|
{ "name": "Configs", "type": "[]DescribeConfigsResourceResult", "versions": "0+",
|
|
"about": "Each listed configuration.", "fields": [
|
|
{ "name": "Name", "type": "string", "versions": "0+",
|
|
"about": "The configuration name." },
|
|
{ "name": "Value", "type": "string", "versions": "0+", "nullableVersions": "0+",
|
|
"about": "The configuration value." },
|
|
{ "name": "ReadOnly", "type": "bool", "versions": "0+",
|
|
"about": "True if the configuration is read-only." },
|
|
{ "name": "IsDefault", "type": "bool", "versions": "0",
|
|
"about": "True if the configuration is not set." },
|
|
// Note: the v0 default for this field that should be exposed to callers is
|
|
// context-dependent. For example, if the resource is a broker, this should default to 4.
|
|
// -1 is just a placeholder value.
|
|
{ "name": "ConfigSource", "type": "int8", "versions": "1+", "default": "-1", "ignorable": true,
|
|
"about": "The configuration source." },
|
|
{ "name": "IsSensitive", "type": "bool", "versions": "0+",
|
|
"about": "True if this configuration is sensitive." },
|
|
{ "name": "Synonyms", "type": "[]DescribeConfigsSynonym", "versions": "1+", "ignorable": true,
|
|
"about": "The synonyms for this configuration key.", "fields": [
|
|
{ "name": "Name", "type": "string", "versions": "1+",
|
|
"about": "The synonym name." },
|
|
{ "name": "Value", "type": "string", "versions": "1+", "nullableVersions": "0+",
|
|
"about": "The synonym value." },
|
|
{ "name": "Source", "type": "int8", "versions": "1+",
|
|
"about": "The synonym source." }
|
|
]}
|
|
]}
|
|
]}
|
|
]
|
|
}
|