Skip to main content

Class: QueryResult

Represents a QueryResult.

Properties​

failed?​

optional failed?: $Properties | null

QueryResult failed.

queryId​

queryId: string

Corresponds to the id provided in the activation job

succeeded?​

optional succeeded?: $Properties | null

QueryResult succeeded.

variant?​

optional variant?: "failed" | "succeeded"

QueryResult variant.

Methods​

toJSON()​

toJSON(): object

Converts this QueryResult to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): QueryResult & $Shape

Creates a new QueryResult instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

QueryResult & $Shape

QueryResult instance

Call Signature​

static create(properties?): QueryResult

Creates a new QueryResult instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

QueryResult

QueryResult instance

decode()​

static decode(reader, length?): QueryResult & $Shape

Decodes a QueryResult message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

QueryResult & $Shape

QueryResult

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): QueryResult & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

QueryResult & $Shape

QueryResult

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified QueryResult message. Does not implicitly coresdk.workflow_commands.QueryResult.verify|verify messages.

Parameters​

message​

$Properties

QueryResult message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

QueryResult message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

Plain 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​

message​

QueryResult

QueryResult

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object