io.aeron.cluster.codecs

Class BackupResponseEncoder

java.lang.Object

io.aeron.cluster.codecs.BackupResponseEncoder

public final class BackupResponseEncoder
extends Object

Response to backup query that includes all relevant information for backup operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackupResponseEncoder.SnapshotsEncoder Snapshots of state for the consensus module and services.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_LENGTH
static ByteOrder	BYTE_ORDER
static int	SCHEMA_ID
static int	SCHEMA_VERSION
static String	SEMANTIC_VERSION
static int	TEMPLATE_ID

Constructor Summary

Constructors

Constructor and Description
BackupResponseEncoder()

Method Summary

Modifier and Type	Method and Description
StringBuilder	appendTo(StringBuilder builder)
MutableDirectBuffer	buffer()
BackupResponseEncoder	clusterMembers(CharSequence value)
BackupResponseEncoder	clusterMembers(String value)
static String	clusterMembersCharacterEncoding()
static int	clusterMembersHeaderLength()
static int	clusterMembersId()
static String	clusterMembersMetaAttribute(MetaAttribute metaAttribute)
BackupResponseEncoder	commitPositionCounterId(int value)
static int	commitPositionCounterIdEncodingLength()
static int	commitPositionCounterIdEncodingOffset()
static int	commitPositionCounterIdId()
static int	commitPositionCounterIdMaxValue()
static String	commitPositionCounterIdMetaAttribute(MetaAttribute metaAttribute)
static int	commitPositionCounterIdMinValue()
static int	commitPositionCounterIdNullValue()
static int	commitPositionCounterIdSinceVersion()
BackupResponseEncoder	correlationId(long value)
static int	correlationIdEncodingLength()
static int	correlationIdEncodingOffset()
static int	correlationIdId()
static long	correlationIdMaxValue()
static String	correlationIdMetaAttribute(MetaAttribute metaAttribute)
static long	correlationIdMinValue()
static long	correlationIdNullValue()
static int	correlationIdSinceVersion()
int	encodedLength()
int	initialOffset()
BackupResponseEncoder	lastLeadershipTermId(long value)
static int	lastLeadershipTermIdEncodingLength()
static int	lastLeadershipTermIdEncodingOffset()
static int	lastLeadershipTermIdId()
static long	lastLeadershipTermIdMaxValue()
static String	lastLeadershipTermIdMetaAttribute(MetaAttribute metaAttribute)
static long	lastLeadershipTermIdMinValue()
static long	lastLeadershipTermIdNullValue()
static int	lastLeadershipTermIdSinceVersion()
BackupResponseEncoder	lastTermBaseLogPosition(long value)
static int	lastTermBaseLogPositionEncodingLength()
static int	lastTermBaseLogPositionEncodingOffset()
static int	lastTermBaseLogPositionId()
static long	lastTermBaseLogPositionMaxValue()
static String	lastTermBaseLogPositionMetaAttribute(MetaAttribute metaAttribute)
static long	lastTermBaseLogPositionMinValue()
static long	lastTermBaseLogPositionNullValue()
static int	lastTermBaseLogPositionSinceVersion()
BackupResponseEncoder	leaderMemberId(int value)
static int	leaderMemberIdEncodingLength()
static int	leaderMemberIdEncodingOffset()
static int	leaderMemberIdId()
static int	leaderMemberIdMaxValue()
static String	leaderMemberIdMetaAttribute(MetaAttribute metaAttribute)
static int	leaderMemberIdMinValue()
static int	leaderMemberIdNullValue()
static int	leaderMemberIdSinceVersion()
int	limit()
void	limit(int limit)
BackupResponseEncoder	logLeadershipTermId(long value)
static int	logLeadershipTermIdEncodingLength()
static int	logLeadershipTermIdEncodingOffset()
static int	logLeadershipTermIdId()
static long	logLeadershipTermIdMaxValue()
static String	logLeadershipTermIdMetaAttribute(MetaAttribute metaAttribute)
static long	logLeadershipTermIdMinValue()
static long	logLeadershipTermIdNullValue()
static int	logLeadershipTermIdSinceVersion()
BackupResponseEncoder	logRecordingId(long value)
static int	logRecordingIdEncodingLength()
static int	logRecordingIdEncodingOffset()
static int	logRecordingIdId()
static long	logRecordingIdMaxValue()
static String	logRecordingIdMetaAttribute(MetaAttribute metaAttribute)
static long	logRecordingIdMinValue()
static long	logRecordingIdNullValue()
static int	logRecordingIdSinceVersion()
BackupResponseEncoder	logTermBaseLogPosition(long value)
static int	logTermBaseLogPositionEncodingLength()
static int	logTermBaseLogPositionEncodingOffset()
static int	logTermBaseLogPositionId()
static long	logTermBaseLogPositionMaxValue()
static String	logTermBaseLogPositionMetaAttribute(MetaAttribute metaAttribute)
static long	logTermBaseLogPositionMinValue()
static long	logTermBaseLogPositionNullValue()
static int	logTermBaseLogPositionSinceVersion()
BackupResponseEncoder	memberId(int value)
static int	memberIdEncodingLength()
static int	memberIdEncodingOffset()
static int	memberIdId()
static int	memberIdMaxValue()
static String	memberIdMetaAttribute(MetaAttribute metaAttribute)
static int	memberIdMinValue()
static int	memberIdNullValue()
static int	memberIdSinceVersion()
int	offset()
BackupResponseEncoder	putClusterMembers(byte[] src, int srcOffset, int length)
BackupResponseEncoder	putClusterMembers(DirectBuffer src, int srcOffset, int length)
int	sbeBlockLength()
int	sbeSchemaId()
int	sbeSchemaVersion()
String	sbeSemanticType()
int	sbeTemplateId()
BackupResponseEncoder.SnapshotsEncoder	snapshotsCount(int count) Snapshots of state for the consensus module and services.
static long	snapshotsId()
String	toString()
BackupResponseEncoder	wrap(MutableDirectBuffer buffer, int offset)
BackupResponseEncoder	wrapAndApplyHeader(MutableDirectBuffer buffer, int offset, MessageHeaderEncoder headerEncoder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLOCK_LENGTH

public static final int BLOCK_LENGTH

See Also:

Constant Field Values

TEMPLATE_ID

public static final int TEMPLATE_ID

See Also:

Constant Field Values

SCHEMA_ID

public static final int SCHEMA_ID

See Also:

Constant Field Values

SCHEMA_VERSION

public static final int SCHEMA_VERSION

See Also:

Constant Field Values

SEMANTIC_VERSION

public static final String SEMANTIC_VERSION

See Also:

Constant Field Values

BYTE_ORDER

public static final ByteOrder BYTE_ORDER

Constructor Detail

BackupResponseEncoder

public BackupResponseEncoder()

Method Detail

sbeBlockLength

public int sbeBlockLength()

sbeTemplateId

public int sbeTemplateId()

sbeSchemaId

public int sbeSchemaId()

sbeSchemaVersion

public int sbeSchemaVersion()

sbeSemanticType

public String sbeSemanticType()

buffer

public MutableDirectBuffer buffer()

initialOffset

public int initialOffset()

offset

public int offset()

wrap

public BackupResponseEncoder wrap(MutableDirectBuffer buffer,
                                  int offset)

wrapAndApplyHeader

public BackupResponseEncoder wrapAndApplyHeader(MutableDirectBuffer buffer,
                                                int offset,
                                                MessageHeaderEncoder headerEncoder)

encodedLength

public int encodedLength()

limit

public int limit()

limit

public void limit(int limit)

correlationIdId

public static int correlationIdId()

correlationIdSinceVersion

public static int correlationIdSinceVersion()

correlationIdEncodingOffset

public static int correlationIdEncodingOffset()

correlationIdEncodingLength

public static int correlationIdEncodingLength()

correlationIdMetaAttribute

public static String correlationIdMetaAttribute(MetaAttribute metaAttribute)

correlationIdNullValue

public static long correlationIdNullValue()

correlationIdMinValue

public static long correlationIdMinValue()

correlationIdMaxValue

public static long correlationIdMaxValue()

correlationId

public BackupResponseEncoder correlationId(long value)

logRecordingIdId

public static int logRecordingIdId()

logRecordingIdSinceVersion

public static int logRecordingIdSinceVersion()

logRecordingIdEncodingOffset

public static int logRecordingIdEncodingOffset()

logRecordingIdEncodingLength

public static int logRecordingIdEncodingLength()

logRecordingIdMetaAttribute

public static String logRecordingIdMetaAttribute(MetaAttribute metaAttribute)

logRecordingIdNullValue

public static long logRecordingIdNullValue()

logRecordingIdMinValue

public static long logRecordingIdMinValue()

logRecordingIdMaxValue

public static long logRecordingIdMaxValue()

logRecordingId

public BackupResponseEncoder logRecordingId(long value)

logLeadershipTermIdId

public static int logLeadershipTermIdId()

logLeadershipTermIdSinceVersion

public static int logLeadershipTermIdSinceVersion()

logLeadershipTermIdEncodingOffset

public static int logLeadershipTermIdEncodingOffset()

logLeadershipTermIdEncodingLength

public static int logLeadershipTermIdEncodingLength()

logLeadershipTermIdMetaAttribute

public static String logLeadershipTermIdMetaAttribute(MetaAttribute metaAttribute)

logLeadershipTermIdNullValue

public static long logLeadershipTermIdNullValue()

logLeadershipTermIdMinValue

public static long logLeadershipTermIdMinValue()

logLeadershipTermIdMaxValue

public static long logLeadershipTermIdMaxValue()

logLeadershipTermId

public BackupResponseEncoder logLeadershipTermId(long value)

logTermBaseLogPositionId

public static int logTermBaseLogPositionId()

logTermBaseLogPositionSinceVersion

public static int logTermBaseLogPositionSinceVersion()

logTermBaseLogPositionEncodingOffset

public static int logTermBaseLogPositionEncodingOffset()

logTermBaseLogPositionEncodingLength

public static int logTermBaseLogPositionEncodingLength()

logTermBaseLogPositionMetaAttribute

public static String logTermBaseLogPositionMetaAttribute(MetaAttribute metaAttribute)

logTermBaseLogPositionNullValue

public static long logTermBaseLogPositionNullValue()

logTermBaseLogPositionMinValue

public static long logTermBaseLogPositionMinValue()

logTermBaseLogPositionMaxValue

public static long logTermBaseLogPositionMaxValue()

logTermBaseLogPosition

public BackupResponseEncoder logTermBaseLogPosition(long value)

lastLeadershipTermIdId

public static int lastLeadershipTermIdId()

lastLeadershipTermIdSinceVersion

public static int lastLeadershipTermIdSinceVersion()

lastLeadershipTermIdEncodingOffset

public static int lastLeadershipTermIdEncodingOffset()

lastLeadershipTermIdEncodingLength

public static int lastLeadershipTermIdEncodingLength()

lastLeadershipTermIdMetaAttribute

public static String lastLeadershipTermIdMetaAttribute(MetaAttribute metaAttribute)

lastLeadershipTermIdNullValue

public static long lastLeadershipTermIdNullValue()

lastLeadershipTermIdMinValue

public static long lastLeadershipTermIdMinValue()

lastLeadershipTermIdMaxValue

public static long lastLeadershipTermIdMaxValue()

lastLeadershipTermId

public BackupResponseEncoder lastLeadershipTermId(long value)

lastTermBaseLogPositionId

public static int lastTermBaseLogPositionId()

lastTermBaseLogPositionSinceVersion

public static int lastTermBaseLogPositionSinceVersion()

lastTermBaseLogPositionEncodingOffset

public static int lastTermBaseLogPositionEncodingOffset()

lastTermBaseLogPositionEncodingLength

public static int lastTermBaseLogPositionEncodingLength()

lastTermBaseLogPositionMetaAttribute

public static String lastTermBaseLogPositionMetaAttribute(MetaAttribute metaAttribute)

lastTermBaseLogPositionNullValue

public static long lastTermBaseLogPositionNullValue()

lastTermBaseLogPositionMinValue

public static long lastTermBaseLogPositionMinValue()

lastTermBaseLogPositionMaxValue

public static long lastTermBaseLogPositionMaxValue()

lastTermBaseLogPosition

public BackupResponseEncoder lastTermBaseLogPosition(long value)

commitPositionCounterIdId

public static int commitPositionCounterIdId()

commitPositionCounterIdSinceVersion

public static int commitPositionCounterIdSinceVersion()

commitPositionCounterIdEncodingOffset

public static int commitPositionCounterIdEncodingOffset()

commitPositionCounterIdEncodingLength

public static int commitPositionCounterIdEncodingLength()

commitPositionCounterIdMetaAttribute

public static String commitPositionCounterIdMetaAttribute(MetaAttribute metaAttribute)

commitPositionCounterIdNullValue

public static int commitPositionCounterIdNullValue()

commitPositionCounterIdMinValue

public static int commitPositionCounterIdMinValue()

commitPositionCounterIdMaxValue

public static int commitPositionCounterIdMaxValue()

commitPositionCounterId

public BackupResponseEncoder commitPositionCounterId(int value)

leaderMemberIdId

public static int leaderMemberIdId()

leaderMemberIdSinceVersion

public static int leaderMemberIdSinceVersion()

leaderMemberIdEncodingOffset

public static int leaderMemberIdEncodingOffset()

leaderMemberIdEncodingLength

public static int leaderMemberIdEncodingLength()

leaderMemberIdMetaAttribute

public static String leaderMemberIdMetaAttribute(MetaAttribute metaAttribute)

leaderMemberIdNullValue

public static int leaderMemberIdNullValue()

leaderMemberIdMinValue

public static int leaderMemberIdMinValue()

leaderMemberIdMaxValue

public static int leaderMemberIdMaxValue()

leaderMemberId

public BackupResponseEncoder leaderMemberId(int value)

memberIdId

public static int memberIdId()

memberIdSinceVersion

public static int memberIdSinceVersion()

memberIdEncodingOffset

public static int memberIdEncodingOffset()

memberIdEncodingLength

public static int memberIdEncodingLength()

memberIdMetaAttribute

public static String memberIdMetaAttribute(MetaAttribute metaAttribute)

memberIdNullValue

public static int memberIdNullValue()

memberIdMinValue

public static int memberIdMinValue()

memberIdMaxValue

public static int memberIdMaxValue()

memberId

public BackupResponseEncoder memberId(int value)

snapshotsId

public static long snapshotsId()

snapshotsCount

public BackupResponseEncoder.SnapshotsEncoder snapshotsCount(int count)

Snapshots of state for the consensus module and services.

Parameters:

count - of times the group will be encoded.

Returns:

SnapshotsEncoder : encoder for the group.

clusterMembersId

public static int clusterMembersId()

clusterMembersCharacterEncoding

public static String clusterMembersCharacterEncoding()

clusterMembersMetaAttribute

public static String clusterMembersMetaAttribute(MetaAttribute metaAttribute)

clusterMembersHeaderLength

public static int clusterMembersHeaderLength()

putClusterMembers

public BackupResponseEncoder putClusterMembers(DirectBuffer src,
                                               int srcOffset,
                                               int length)

putClusterMembers

public BackupResponseEncoder putClusterMembers(byte[] src,
                                               int srcOffset,
                                               int length)

clusterMembers

public BackupResponseEncoder clusterMembers(String value)

clusterMembers

public BackupResponseEncoder clusterMembers(CharSequence value)

toString

public String toString()

Overrides:

toString in class Object

appendTo

public StringBuilder appendTo(StringBuilder builder)