JSDoc: Class: CatchUp

new CatchUp(opt_dataopt)

Generated by JsPbCodeGenerator.

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 39

Extends

jspb.Message

Classes

Request

Members

(static) displayName

Source:

proto/spine/server/catchup/catch_up_pb.js, line 48

Methods

addAffectedShard(value, opt_indexopt) → (non-null) {proto.spine.server.catchup.CatchUp}

Parameters:

Name	Type	Attributes	Description
`value`	number
`opt_index`	number	<optional>

Source:

proto/spine/server/catchup/catch_up_pb.js, line 707

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

clearAffectedShardList() → (non-null) {proto.spine.server.catchup.CatchUp}

Clears the list making it empty but non-null.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 716

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

clearId() → (non-null) {proto.spine.server.catchup.CatchUp}

Clears the message field making it undefined.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 560

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

clearRequest() → (non-null) {proto.spine.server.catchup.CatchUp}

Clears the message field making it undefined.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 597

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

clearWhenLastRead() → (non-null) {proto.spine.server.catchup.CatchUp}

Clears the message field making it undefined.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 634

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

getAffectedShardList() → (non-null) {Array.<number>}

repeated int32 affected_shard = 6;

Source:

proto/spine/server/catchup/catch_up_pb.js, line 688

Returns:

Type: Array.<number>

getId() → (nullable) {proto.spine.server.catchup.CatchUpId}

optional CatchUpId id = 1;

Source:

proto/spine/server/catchup/catch_up_pb.js, line 541

Returns:

Type: proto.spine.server.catchup.CatchUpId

getRequest() → (nullable) {proto.spine.server.catchup.CatchUp.Request}

optional Request request = 2;

Source:

proto/spine/server/catchup/catch_up_pb.js, line 578

Returns:

Type: proto.spine.server.catchup.CatchUp.Request

getStatus() → (non-null) {proto.spine.server.catchup.CatchUpStatus}

optional CatchUpStatus status = 4;

Source:

proto/spine/server/catchup/catch_up_pb.js, line 652

Returns:

Type: proto.spine.server.catchup.CatchUpStatus

getTotalShards() → {number}

optional int32 total_shards = 5;

Source:

proto/spine/server/catchup/catch_up_pb.js, line 670

Returns:

Type: number

getWhenLastRead() → (nullable) {proto.google.protobuf.Timestamp}

optional google.protobuf.Timestamp when_last_read = 3;

Source:

proto/spine/server/catchup/catch_up_pb.js, line 615

Returns:

Type: proto.google.protobuf.Timestamp

hasId() → {boolean}

Returns whether this field is set.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 569

Returns:

Type: boolean

hasRequest() → {boolean}

Returns whether this field is set.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 606

Returns:

Type: boolean

hasWhenLastRead() → {boolean}

Returns whether this field is set.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 643

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).

Source:

proto/spine/server/catchup/catch_up_pb.js, line 213

Returns:

Type: Uint8Array

setAffectedShardList(valuenon-null) → (non-null) {proto.spine.server.catchup.CatchUp}

Parameters:

Name	Type	Description
`value`	Array.<number>

Source:

proto/spine/server/catchup/catch_up_pb.js, line 697

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

setId(value) → (non-null) {proto.spine.server.catchup.CatchUp}

Parameters:

Name	Type	Description
`value`	proto.spine.server.catchup.CatchUpId \| undefined

Source:

proto/spine/server/catchup/catch_up_pb.js, line 551

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

setRequest(value) → (non-null) {proto.spine.server.catchup.CatchUp}

Parameters:

Name	Type	Description
`value`	proto.spine.server.catchup.CatchUp.Request \| undefined

Source:

proto/spine/server/catchup/catch_up_pb.js, line 588

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

setStatus(valuenon-null) → (non-null) {proto.spine.server.catchup.CatchUp}

Parameters:

Name	Type	Description
`value`	proto.spine.server.catchup.CatchUpStatus

Source:

proto/spine/server/catchup/catch_up_pb.js, line 661

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

setTotalShards(value) → (non-null) {proto.spine.server.catchup.CatchUp}

Parameters:

Name	Type	Description
`value`	number

Source:

proto/spine/server/catchup/catch_up_pb.js, line 679

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

setWhenLastRead(value) → (non-null) {proto.spine.server.catchup.CatchUp}

Parameters:

Name	Type	Description
`value`	proto.google.protobuf.Timestamp \| undefined

Source:

proto/spine/server/catchup/catch_up_pb.js, line 625

Returns:

returns this

Type: proto.spine.server.catchup.CatchUp

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Source:

proto/spine/server/catchup/catch_up_pb.js, line 115

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.spine.server.catchup.CatchUp}

Deserializes binary data (in protobuf wire format).

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 152

Returns:

Type: proto.spine.server.catchup.CatchUp

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.spine.server.catchup.CatchUp}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Parameters:

Name	Type	Description
`msg`	proto.spine.server.catchup.CatchUp	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 166

Returns:

Type: proto.spine.server.catchup.CatchUp

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Parameters:

Name	Type	Description
`message`	proto.spine.server.catchup.CatchUp
`writer`	jspb.BinaryWriter

Source:

proto/spine/server/catchup/catch_up_pb.js, line 227

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.spine.server.catchup.CatchUp	The msg instance to transform.

Source:

proto/spine/server/catchup/catch_up_pb.js, line 129

Returns:

Type: Object