Class: EventStreamQuery

EventStreamQuery(opt_dataopt)

new EventStreamQuery(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:

Extends

  • jspb.Message

Classes

Limit

Members

(static) displayName

Source:

Methods

addFilter(opt_valueopt, non-null, opt_indexopt) → (non-null) {proto.spine.server.event.EventFilter}

Parameters:
Name Type Attributes Description
opt_value proto.spine.server.event.EventFilter <optional>
opt_index number <optional>
Source:
Returns:
Type
proto.spine.server.event.EventFilter

clearAfter() → (non-null) {proto.spine.server.event.EventStreamQuery}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

clearBefore() → (non-null) {proto.spine.server.event.EventStreamQuery}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

clearFilterList() → (non-null) {proto.spine.server.event.EventStreamQuery}

Clears the list making it empty but non-null.
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

clearLimit() → (non-null) {proto.spine.server.event.EventStreamQuery}

Clears the message field making it undefined.
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

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

optional google.protobuf.Timestamp after = 1;
Source:
Returns:
Type
proto.google.protobuf.Timestamp

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

optional google.protobuf.Timestamp before = 2;
Source:
Returns:
Type
proto.google.protobuf.Timestamp

getFilterList() → (non-null) {Array.<!proto.spine.server.event.EventFilter>}

repeated EventFilter filter = 3;
Source:
Returns:
Type
Array.<!proto.spine.server.event.EventFilter>

getLimit() → (nullable) {proto.spine.server.event.EventStreamQuery.Limit}

optional Limit limit = 4;
Source:
Returns:
Type
proto.spine.server.event.EventStreamQuery.Limit

hasAfter() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasBefore() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

hasLimit() → {boolean}

Returns whether this field is set.
Source:
Returns:
Type
boolean

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

Serializes the message to binary data (in protobuf wire format).
Source:
Returns:
Type
Uint8Array

setAfter(value) → (non-null) {proto.spine.server.event.EventStreamQuery}

Parameters:
Name Type Description
value proto.google.protobuf.Timestamp | undefined
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

setBefore(value) → (non-null) {proto.spine.server.event.EventStreamQuery}

Parameters:
Name Type Description
value proto.google.protobuf.Timestamp | undefined
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

setFilterList(valuenon-null) → (non-null) {proto.spine.server.event.EventStreamQuery}

Parameters:
Name Type Description
value Array.<!proto.spine.server.event.EventFilter>
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

setLimit(value) → (non-null) {proto.spine.server.event.EventStreamQuery}

Parameters:
Name Type Description
value proto.spine.server.event.EventStreamQuery.Limit | undefined
Source:
Returns:
returns this
Type
proto.spine.server.event.EventStreamQuery

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:
Returns:
Type
Object

(static) deserializeBinary(bytes) → (non-null) {proto.spine.server.event.EventStreamQuery}

Deserializes binary data (in protobuf wire format).
Parameters:
Name Type Description
bytes jspb.ByteSource The bytes to deserialize.
Source:
Returns:
Type
proto.spine.server.event.EventStreamQuery

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

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.
Parameters:
Name Type Description
msg proto.spine.server.event.EventStreamQuery The message object to deserialize into.
reader jspb.BinaryReader The BinaryReader to use.
Source:
Returns:
Type
proto.spine.server.event.EventStreamQuery

(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.event.EventStreamQuery
writer jspb.BinaryWriter
Source:

(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.event.EventStreamQuery The msg instance to transform.
Source:
Returns:
Type
Object