org.tikv.kvproto

Interface Pdpb.RegionHeartbeatResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Pdpb.RegionHeartbeatResponse, Pdpb.RegionHeartbeatResponse.Builder

Enclosing class:

Pdpb

public static interface Pdpb.RegionHeartbeatResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Pdpb.ChangePeer	getChangePeer() Notice, Pd only allows handling reported epoch >= current pd's.
Pdpb.ChangePeerOrBuilder	getChangePeerOrBuilder() Notice, Pd only allows handling reported epoch >= current pd's.
Pdpb.ChangePeerV2	getChangePeerV2() Multiple change peer operations atomically.
Pdpb.ChangePeerV2OrBuilder	getChangePeerV2OrBuilder() Multiple change peer operations atomically.
Pdpb.ResponseHeader	getHeader() .pdpb.ResponseHeader header = 1;
Pdpb.ResponseHeaderOrBuilder	getHeaderOrBuilder() .pdpb.ResponseHeader header = 1;
Pdpb.Merge	getMerge() .pdpb.Merge merge = 7;
Pdpb.MergeOrBuilder	getMergeOrBuilder() .pdpb.Merge merge = 7;
Metapb.RegionEpoch	getRegionEpoch() .metapb.RegionEpoch region_epoch = 5;
Metapb.RegionEpochOrBuilder	getRegionEpochOrBuilder() .metapb.RegionEpoch region_epoch = 5;
long	getRegionId() ID of the region
Pdpb.SplitRegion	getSplitRegion() PD sends split_region to let TiKV split a region into two regions.
Pdpb.SplitRegionOrBuilder	getSplitRegionOrBuilder() PD sends split_region to let TiKV split a region into two regions.
Metapb.Peer	getTargetPeer() Leader of the region at the moment of the corresponding request was made.
Metapb.PeerOrBuilder	getTargetPeerOrBuilder() Leader of the region at the moment of the corresponding request was made.
Pdpb.TransferLeader	getTransferLeader() Pd can return transfer_leader to let TiKV does leader transfer itself.
Pdpb.TransferLeaderOrBuilder	getTransferLeaderOrBuilder() Pd can return transfer_leader to let TiKV does leader transfer itself.
boolean	hasChangePeer() Notice, Pd only allows handling reported epoch >= current pd's.
boolean	hasChangePeerV2() Multiple change peer operations atomically.
boolean	hasHeader() .pdpb.ResponseHeader header = 1;
boolean	hasMerge() .pdpb.Merge merge = 7;
boolean	hasRegionEpoch() .metapb.RegionEpoch region_epoch = 5;
boolean	hasSplitRegion() PD sends split_region to let TiKV split a region into two regions.
boolean	hasTargetPeer() Leader of the region at the moment of the corresponding request was made.
boolean	hasTransferLeader() Pd can return transfer_leader to let TiKV does leader transfer itself.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasHeader

boolean hasHeader()

.pdpb.ResponseHeader header = 1;

Returns:

Whether the header field is set.

getHeader

Pdpb.ResponseHeader getHeader()

.pdpb.ResponseHeader header = 1;

Returns:

The header.

getHeaderOrBuilder

Pdpb.ResponseHeaderOrBuilder getHeaderOrBuilder()

.pdpb.ResponseHeader header = 1;

hasChangePeer

boolean hasChangePeer()

 Notice, Pd only allows handling reported epoch >= current pd's.
 Leader peer reports region status with RegionHeartbeatRequest
 to pd regularly, pd will determine whether this region
 should do ChangePeer or not.
 E,g, max peer number is 3, region A, first only peer 1 in A.
 1. Pd region state -> Peers (1), ConfVer (1).
 2. Leader peer 1 reports region state to pd, pd finds the
 peer number is < 3, so first changes its current region
 state -> Peers (1, 2), ConfVer (1), and returns ChangePeer Adding 2.
 3. Leader does ChangePeer, then reports Peers (1, 2), ConfVer (2),
 pd updates its state -> Peers (1, 2), ConfVer (2).
 4. Leader may report old Peers (1), ConfVer (1) to pd before ConfChange
 finished, pd stills responses ChangePeer Adding 2, of course, we must
 guarantee the second ChangePeer can't be applied in TiKV.
 

.pdpb.ChangePeer change_peer = 2;

Returns:

Whether the changePeer field is set.

getChangePeer

Pdpb.ChangePeer getChangePeer()

 Notice, Pd only allows handling reported epoch >= current pd's.
 Leader peer reports region status with RegionHeartbeatRequest
 to pd regularly, pd will determine whether this region
 should do ChangePeer or not.
 E,g, max peer number is 3, region A, first only peer 1 in A.
 1. Pd region state -> Peers (1), ConfVer (1).
 2. Leader peer 1 reports region state to pd, pd finds the
 peer number is < 3, so first changes its current region
 state -> Peers (1, 2), ConfVer (1), and returns ChangePeer Adding 2.
 3. Leader does ChangePeer, then reports Peers (1, 2), ConfVer (2),
 pd updates its state -> Peers (1, 2), ConfVer (2).
 4. Leader may report old Peers (1), ConfVer (1) to pd before ConfChange
 finished, pd stills responses ChangePeer Adding 2, of course, we must
 guarantee the second ChangePeer can't be applied in TiKV.
 

.pdpb.ChangePeer change_peer = 2;

Returns:

The changePeer.

getChangePeerOrBuilder

Pdpb.ChangePeerOrBuilder getChangePeerOrBuilder()

 Notice, Pd only allows handling reported epoch >= current pd's.
 Leader peer reports region status with RegionHeartbeatRequest
 to pd regularly, pd will determine whether this region
 should do ChangePeer or not.
 E,g, max peer number is 3, region A, first only peer 1 in A.
 1. Pd region state -> Peers (1), ConfVer (1).
 2. Leader peer 1 reports region state to pd, pd finds the
 peer number is < 3, so first changes its current region
 state -> Peers (1, 2), ConfVer (1), and returns ChangePeer Adding 2.
 3. Leader does ChangePeer, then reports Peers (1, 2), ConfVer (2),
 pd updates its state -> Peers (1, 2), ConfVer (2).
 4. Leader may report old Peers (1), ConfVer (1) to pd before ConfChange
 finished, pd stills responses ChangePeer Adding 2, of course, we must
 guarantee the second ChangePeer can't be applied in TiKV.
 

.pdpb.ChangePeer change_peer = 2;

hasTransferLeader

boolean hasTransferLeader()

 Pd can return transfer_leader to let TiKV does leader transfer itself.
 

.pdpb.TransferLeader transfer_leader = 3;

Returns:

Whether the transferLeader field is set.

getTransferLeader

Pdpb.TransferLeader getTransferLeader()

 Pd can return transfer_leader to let TiKV does leader transfer itself.
 

.pdpb.TransferLeader transfer_leader = 3;

Returns:

The transferLeader.

getTransferLeaderOrBuilder

Pdpb.TransferLeaderOrBuilder getTransferLeaderOrBuilder()

 Pd can return transfer_leader to let TiKV does leader transfer itself.
 

.pdpb.TransferLeader transfer_leader = 3;

getRegionId

long getRegionId()

 ID of the region
 

uint64 region_id = 4;

Returns:

The regionId.

hasRegionEpoch

boolean hasRegionEpoch()

.metapb.RegionEpoch region_epoch = 5;

Returns:

Whether the regionEpoch field is set.

getRegionEpoch

Metapb.RegionEpoch getRegionEpoch()

.metapb.RegionEpoch region_epoch = 5;

Returns:

The regionEpoch.

getRegionEpochOrBuilder

Metapb.RegionEpochOrBuilder getRegionEpochOrBuilder()

.metapb.RegionEpoch region_epoch = 5;

hasTargetPeer

boolean hasTargetPeer()

 Leader of the region at the moment of the corresponding request was made.
 

.metapb.Peer target_peer = 6;

Returns:

Whether the targetPeer field is set.

getTargetPeer

Metapb.Peer getTargetPeer()

 Leader of the region at the moment of the corresponding request was made.
 

.metapb.Peer target_peer = 6;

Returns:

The targetPeer.

getTargetPeerOrBuilder

Metapb.PeerOrBuilder getTargetPeerOrBuilder()

 Leader of the region at the moment of the corresponding request was made.
 

.metapb.Peer target_peer = 6;

hasMerge

boolean hasMerge()

.pdpb.Merge merge = 7;

Returns:

Whether the merge field is set.

getMerge

Pdpb.Merge getMerge()

.pdpb.Merge merge = 7;

Returns:

The merge.

getMergeOrBuilder

Pdpb.MergeOrBuilder getMergeOrBuilder()

.pdpb.Merge merge = 7;

hasSplitRegion

boolean hasSplitRegion()

 PD sends split_region to let TiKV split a region into two regions.
 

.pdpb.SplitRegion split_region = 8;

Returns:

Whether the splitRegion field is set.

getSplitRegion

Pdpb.SplitRegion getSplitRegion()

 PD sends split_region to let TiKV split a region into two regions.
 

.pdpb.SplitRegion split_region = 8;

Returns:

The splitRegion.

getSplitRegionOrBuilder

Pdpb.SplitRegionOrBuilder getSplitRegionOrBuilder()

 PD sends split_region to let TiKV split a region into two regions.
 

.pdpb.SplitRegion split_region = 8;

hasChangePeerV2

boolean hasChangePeerV2()

 Multiple change peer operations atomically.
 Note: PD can use both ChangePeer and ChangePeerV2 at the same time
       (not in the same RegionHeartbeatResponse).
       Now, PD use ChangePeerV2 in following scenarios:
       1. replacing peers
       2. demoting voter directly
 

.pdpb.ChangePeerV2 change_peer_v2 = 9;

Returns:

Whether the changePeerV2 field is set.

getChangePeerV2

Pdpb.ChangePeerV2 getChangePeerV2()

 Multiple change peer operations atomically.
 Note: PD can use both ChangePeer and ChangePeerV2 at the same time
       (not in the same RegionHeartbeatResponse).
       Now, PD use ChangePeerV2 in following scenarios:
       1. replacing peers
       2. demoting voter directly
 

.pdpb.ChangePeerV2 change_peer_v2 = 9;

Returns:

The changePeerV2.

getChangePeerV2OrBuilder

Pdpb.ChangePeerV2OrBuilder getChangePeerV2OrBuilder()

 Multiple change peer operations atomically.
 Note: PD can use both ChangePeer and ChangePeerV2 at the same time
       (not in the same RegionHeartbeatResponse).
       Now, PD use ChangePeerV2 in following scenarios:
       1. replacing peers
       2. demoting voter directly
 

.pdpb.ChangePeerV2 change_peer_v2 = 9;