ebe-protocol.8.6.0-alpha4-rc1.source-code.cluster-management-protocol.xml Maven / Gradle / Ivy
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<sbe:messageSchema xmlns:sbe="http://fixprotocol.io/2016/sbe"
xmlns:xi="http://www.w3.org/2001/XInclude" package="io.camunda.zeebe.protocol.management"
id="1" version="0" semanticVersion="${project.version}"
description="Zeebe Cluster Management Protocol" byteOrder="littleEndian">
<xi:include href="common-types.xml"/>
<types>
<enum name="AdminRequestType" encodingType="uint8">
<validValue name="STEP_DOWN_IF_NOT_PRIMARY">0</validValue>
<validValue name="PAUSE_EXPORTING">1</validValue>
<validValue name="RESUME_EXPORTING">2</validValue>
<validValue name="BAN_INSTANCE">3</validValue>
<validValue name="SOFT_PAUSE_EXPORTING">4</validValue>
<validValue name="SET_FLOW_CONTROL">5</validValue>
<validValue name="GET_FLOW_CONTROL">6</validValue>
</enum>
<enum name="BackupRequestType" encodingType="uint8">
<validValue name="TAKE_BACKUP">0</validValue>
<validValue name="QUERY_STATUS">1</validValue>
<validValue name="LIST">2</validValue>
<validValue name="DELETE">3</validValue>
</enum>
<enum name="BackupStatusCode" encodingType="uint8">
<validValue name="DOES_NOT_EXIST">0</validValue>
<validValue name="IN_PROGRESS">1</validValue>
<validValue name="COMPLETED">2</validValue>
<validValue name="FAILED">3</validValue>
</enum>
<composite name="largeGroupSizeEncoding">
<!-- Similar to groupSizeEncoding in common-types.xml but uses uint16 instead of uint8 to count entries.-->
<type name="blockLength" primitiveType="uint16"/>
<type name="numInGroup" primitiveType="uint16"/>
<type name="numGroups" primitiveType="uint16"/>
<type name="numVarDataFields" primitiveType="uint16"/>
</composite>
</types>
<sbe:message name="AdminRequest" id="1">
<field name="partitionId" id="1" type="uint16"/>
<field name="type" id="2" type="AdminRequestType"/>
<field name="brokerId" id="3" type="uint16" presence="optional"/>
<field name="key" id="4" type="uint64" presence="optional"/>
<data name="payload" id="5" type="varDataEncoding"/>
</sbe:message>
<sbe:message name="AdminResponse" id="2">
<data name="payload" id="1" type="varDataEncoding"/>
</sbe:message>
<sbe:message name="BackupRequest" id="3">
<field name="partitionId" id="1" type="uint16"/>
<field name="type" id="2" type="BackupRequestType"/>
<field name="backupId" id="3" type="int64"/>
</sbe:message>
<sbe:message name="BackupStatusResponse" id="4">
<field name="backupId" id="1" type="int64"/>
<field name="status" id="2" type="BackupStatusCode"/>
<field name="partitionId" id="3" type="uint16"/>
<field name="brokerId" id="4" type="uint16"/>
<!-- Following fields will have a valid value if status == COMPLETED or status == INPROGRESS -->
<field name="checkpointPosition" id="5" type="int64"/>
<field name="numberOfPartitions" id="6" type="uint16"/>
<data name="snapshotId" id="7" type="varDataEncoding"/>
<!-- failure reason will have a valid value if status == FAILED -->
<data name="failureReason" id="8" type="varDataEncoding"/>
<!-- Following fields will have a valid value if status == COMPLETED or status == INPROGRESS -->
<data name="createdAt" id="9" type="varDataEncoding"/>
<data name="lastUpdated" id="10" type="varDataEncoding"/>
<!-- Broker version which created this backup -->
<data name="brokerVersion" id="11" type="varDataEncoding"/>
</sbe:message>
<sbe:message name="BackupListResponse" id="5">
<!-- This response contains a subset of fields from BackupStatusResponse -->
<group name="backups" id="1" dimensionType="largeGroupSizeEncoding">
<field name="backupId" id="1" type="int64"/>
<field name="status" id="2" type="BackupStatusCode"/>
<field name="partitionId" id="3" type="uint16"/>
<!-- failure reason will have a valid value if status == FAILED -->
<data name="failureReason" id="8" type="varDataEncoding"/>
<data name="createdAt" id="9" type="varDataEncoding"/>
<!-- Broker version which created this backup -->
<data name="brokerVersion" id="11" type="varDataEncoding"/>
</group>
</sbe:message>
</sbe:messageSchema>