Definitions

AddPartition

Name	Schema
numPartitionsAdded optional	integer(int32)
replicaAssignment optional	< < integer(int32) > array > array
topic optional	string

BrokerInfo

Name	Schema
endpoints optional	< string > array
host optional	string
id optional	integer(int32)
jmxPort optional	integer(int32)
port optional	integer(int32)
rack optional	string
securityProtocol optional	object
startTime optional	string(date-time)
version optional	integer(int32)

ClusterInfo

Name	Schema
clusterId optional	string
controller optional	Node
nodes optional	< Node > array

ConsumerGroupDesc

Name	Schema
assignmentStrategy optional	string
clientId optional	string
consumerId optional	string
coordinator optional	Node
currentOffset optional	integer(int64)
groupName optional	string
host optional	string
lag optional	integer(int64)
logEndOffset optional	integer(int64)
partitionId optional	integer(int32)
state optional	enum (Unknown, PreparingRebalance, CompletingRebalance, Stable, Dead, Empty)
topic optional	string
type optional	enum (NEW, OLD)

ConsumerGroupMeta

Name	Schema
assignmentStrategy optional	string
coordinator optional	Node
groupId optional	string
members optional	< MemberDescription > array
state optional	enum (Unknown, PreparingRebalance, CompletingRebalance, Stable, Dead, Empty)

CustomConfigEntry

Name	Schema
isReadOnly optional	boolean
isSensitive optional	boolean
name optional	string
readOnly optional	boolean
sensitive optional	boolean
source optional	enum (DYNAMIC_TOPIC_CONFIG, DYNAMIC_BROKER_CONFIG, DYNAMIC_DEFAULT_BROKER_CONFIG, STATIC_BROKER_CONFIG, DEFAULT_CONFIG, UNKNOWN)
value optional	string

CustomTopicPartitionInfo

Name	Schema
endOffset optional	integer(int64)
in_sync optional	boolean
messageAvailable optional	integer(int64)
startOffset optional	integer(int64)
topicPartitionInfo optional	TopicPartitionInfo

GeneralResponse

Name	Schema
data optional	object
msg optional	string
state optional	enum (success, failure)

HashMap«string,object»

Type : < string, object > map

HealthCheckResult

Name	Description	Schema
msg optional		string
status optional		string
timestamp optional	Example : `"yyyy-MM-dd HH:mm:ss"`	string

HostAndPort

Name	Schema
hasBracketlessColons optional	boolean
host optional	string
hostText optional	string
port optional	integer(int32)

JMXConfiguration

Name	Schema
exclude optional	JMXFilter
include optional	JMXFilter

JMXFilter

Name	Schema
attribute optional	object
beanNames optional	< string > array
beanRegexes optional	< Pattern > array
domain optional	string
domainRegex optional	Pattern
emptyBeanName optional	boolean
filter optional	< string, object > map

JMXMetricData

Name	Description	Schema
collected optional		boolean
host optional		string
metrics optional		< HashMap«string,object» > array
msg optional		string
timestamp optional	Example : `"yyyy-MM-dd HH:mm:ss"`	string

JMXMetricDataV1

Name	Description	Schema
collected optional		boolean
host optional		string
mbeanInfo optional		object
msg optional		string
timestamp optional	Example : `"yyyy-MM-dd HH:mm:ss"`	string

JMXQuery

Name	Schema
filters optional	< JMXConfiguration > array

LogDirInfo

Name

Schema

error
optional

enum (UNKNOWN_SERVER_ERROR, NONE, OFFSET_OUT_OF_RANGE, CORRUPT_MESSAGE, UNKNOWN_TOPIC_OR_PARTITION, INVALID_FETCH_SIZE, LEADER_NOT_AVAILABLE, NOT_LEADER_FOR_PARTITION, REQUEST_TIMED_OUT, BROKER_NOT_AVAILABLE, REPLICA_NOT_AVAILABLE, MESSAGE_TOO_LARGE, STALE_CONTROLLER_EPOCH, OFFSET_METADATA_TOO_LARGE, NETWORK_EXCEPTION, COORDINATOR_LOAD_IN_PROGRESS, COORDINATOR_NOT_AVAILABLE, NOT_COORDINATOR, INVALID_TOPIC_EXCEPTION, RECORD_LIST_TOO_LARGE, NOT_ENOUGH_REPLICAS, NOT_ENOUGH_REPLICAS_AFTER_APPEND, INVALID_REQUIRED_ACKS, ILLEGAL_GENERATION, INCONSISTENT_GROUP_PROTOCOL, INVALID_GROUP_ID, UNKNOWN_MEMBER_ID, INVALID_SESSION_TIMEOUT, REBALANCE_IN_PROGRESS, INVALID_COMMIT_OFFSET_SIZE, TOPIC_AUTHORIZATION_FAILED, GROUP_AUTHORIZATION_FAILED, CLUSTER_AUTHORIZATION_FAILED, INVALID_TIMESTAMP, UNSUPPORTED_SASL_MECHANISM, ILLEGAL_SASL_STATE, UNSUPPORTED_VERSION, TOPIC_ALREADY_EXISTS, INVALID_PARTITIONS, INVALID_REPLICATION_FACTOR, INVALID_REPLICA_ASSIGNMENT, INVALID_CONFIG, NOT_CONTROLLER, INVALID_REQUEST, UNSUPPORTED_FOR_MESSAGE_FORMAT, POLICY_VIOLATION, OUT_OF_ORDER_SEQUENCE_NUMBER, DUPLICATE_SEQUENCE_NUMBER, INVALID_PRODUCER_EPOCH, INVALID_TXN_STATE, INVALID_PRODUCER_ID_MAPPING, INVALID_TRANSACTION_TIMEOUT, CONCURRENT_TRANSACTIONS, TRANSACTION_COORDINATOR_FENCED, TRANSACTIONAL_ID_AUTHORIZATION_FAILED, SECURITY_DISABLED, OPERATION_NOT_ATTEMPTED, KAFKA_STORAGE_ERROR, LOG_DIR_NOT_FOUND, SASL_AUTHENTICATION_FAILED, UNKNOWN_PRODUCER_ID, REASSIGNMENT_IN_PROGRESS, DELEGATION_TOKEN_AUTH_DISABLED, DELEGATION_TOKEN_NOT_FOUND, DELEGATION_TOKEN_OWNER_MISMATCH, DELEGATION_TOKEN_REQUEST_NOT_ALLOWED, DELEGATION_TOKEN_AUTHORIZATION_FAILED, DELEGATION_TOKEN_EXPIRED, INVALID_PRINCIPAL_TYPE, NON_EMPTY_GROUP, GROUP_ID_NOT_FOUND, FETCH_SESSION_ID_NOT_FOUND, INVALID_FETCH_SESSION_EPOCH)

replicaInfos
optional

< string, ReplicaInfo > map

Map«int,long»

Type : < string, integer(int64) > map

Map«string,LogDirInfo»

Type : < string, LogDirInfo > map

MemberDescription

Name	Schema
assignment optional	< TopicPartition > array
clientId optional	string
host optional	string
memberId optional	string

Node

Name	Schema
empty optional	boolean
hash optional	integer(int32)
host optional	string
id optional	integer(int32)
idString optional	string
port optional	integer(int32)
rack optional	string

Pattern

Name	Schema
cursor optional	integer(int32)
flags optional	integer(int32)
pattern optional	string

ReassignModel

Name	Schema
partitions optional	< TopicPartitionReplicaAssignment > array
version optional	integer(int32)

ReassignStatus

Name	Schema
msg optional	string
partitionsReassignStatus optional	< string, integer(int32) > map
removeThrottle optional	boolean
replicasReassignStatus optional	< string, integer(int32) > map

ReassignWrapper

Name	Schema
brokers optional	< integer(int32) > array
topics optional	< string > array

Record

Name	Schema
key optional	string
keyDecoder optional	string
offset optional	integer(int64)
timestamp optional	integer(int64)
topic optional	string
value optional	string
valueDecoder optional	string

ReplicaInfo

Name	Schema
isFuture optional	boolean
offsetLag optional	integer(int64)
size optional	integer(int64)

ReplicaLogDirInfo

Name	Schema
currentReplicaLogDir optional	string
currentReplicaOffsetLag optional	integer(int64)
futureReplicaLogDir optional	string
futureReplicaOffsetLag optional	integer(int64)

SchemaMetadata

Name	Schema
id optional	integer(int32)
schema optional	string
version optional	integer(int32)

SchemaRegistryMetadata

Name	Schema
id optional	integer(int32)
schema optional	string
subject optional	string
version optional	integer(int32)

TopicBrief

Name	Schema
isrRate optional	number(double)
numPartition optional	integer(int32)
replicationFactor optional	integer(int32)
topic optional	string

TopicDetail

Name	Schema
factor optional	integer(int32)
name optional	string
partitions optional	integer(int32)
prop optional	< string, object > map
replicasAssignments optional	< string, < integer(int32) > array > map

TopicMeta

Name	Schema
internal optional	boolean
partitionCount optional	integer(int32)
replicationFactor optional	integer(int32)
topicName optional	string
topicPartitionInfos optional	< CustomTopicPartitionInfo > array

TopicPartition

Name	Schema
hash optional	integer(int32)
partition optional	integer(int32)
topic optional	string

TopicPartitionInfo

Name	Schema
isr optional	< Node > array
leader optional	Node
partition optional	integer(int32)
replicas optional	< Node > array

TopicPartitionReplicaAssignment

Name	Schema
log_dirs optional	< string > array
partition optional	integer(int32)
replicas optional	< integer(int32) > array
topic optional	string

User

Name	Schema
password optional	string
role optional	string
username optional	string

ZkServerClient

Name	Schema
host optional	string
ops optional	integer(int32)
port optional	integer(int32)
queued optional	integer(int32)
received optional	integer(int32)
sent optional	integer(int32)

ZkServerEnvironment

Name	Schema
attributes optional	< string, string > map

ZkServerStat

Name	Schema
avgLatency optional	integer(int32)
buildDate optional	string
clients optional	< ZkServerClient > array
connections optional	integer(int32)
maxLatency optional	integer(int32)
minLatency optional	integer(int32)
mode optional	enum (Leader, Follower, Observer, Standalone, Down, Unknow)
msg optional	string
nodes optional	integer(int32)
outstanding optional	integer(int32)
received optional	integer(int32)
sent optional	integer(int32)
version optional	string
zxId optional	string

Files

definitions.adoc

Latest commit

History