Skip to main content

Class: QueryResult

coresdk.workflow_commands.QueryResult

Represents a QueryResult.

Implements#

Constructors#

constructor#

new QueryResult(properties?)

Constructs a new QueryResult.

Parameters#

NameType
properties?IQueryResult

Properties#

failed#

Optional failed: null | IFailure

QueryResult failed.

Implementation of#

IQueryResult.failed


queryId#

queryId: string

Corresponds to the id provided in the activation job

Implementation of#

IQueryResult.queryId


succeeded#

Optional succeeded: null | IQuerySuccess

QueryResult succeeded.

Implementation of#

IQueryResult.succeeded


variant#

Optional variant: "failed" | "succeeded"

QueryResult variant.

Methods#

toJSON#

toJSON(): Object

Converts this QueryResult to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): QueryResult

Decodes a QueryResult message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

QueryResult

QueryResult


decodeDelimited#

Static decodeDelimited(reader): QueryResult

Decodes a QueryResult message from the specified reader or buffer, length delimited.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

QueryResult

QueryResult


encode#

Static encode(message, writer?): Writer

Encodes the specified QueryResult message. Does not implicitly {@link coresdk.workflow_commands.QueryResult.verify|verify} messages.

Parameters#

NameTypeDescription
messageIQueryResultQueryResult message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified QueryResult message, length delimited. Does not implicitly {@link coresdk.workflow_commands.QueryResult.verify|verify} messages.

Parameters#

NameTypeDescription
messageIQueryResultQueryResult message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): QueryResult

Creates a QueryResult message from a plain object. Also converts values to their respective internal types.

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

QueryResult

QueryResult


toObject#

Static toObject(message, options?): Object

Creates a plain object from a QueryResult message. Also converts values to other types if specified.

Parameters#

NameTypeDescription
messageQueryResultQueryResult
options?IConversionOptions-

Returns#

Object

Plain object