Skip to main content

Class: QuerySuccess

coresdk.workflow_commands.QuerySuccess

Represents a QuerySuccess.

Implements

Constructors

constructor

new QuerySuccess(properties?): QuerySuccess

Constructs a new QuerySuccess.

Parameters

NameTypeDescription
properties?IQuerySuccessProperties to set

Returns

QuerySuccess

Properties

response

Optional response: null | IPayload

QuerySuccess response.

Implementation of

IQuerySuccess.response

Methods

toJSON

toJSON(): Object

Converts this QuerySuccess to JSON.

Returns

Object

JSON object


create

create(properties?): QuerySuccess

Creates a new QuerySuccess instance using the specified properties.

Parameters

NameTypeDescription
properties?IQuerySuccessProperties to set

Returns

QuerySuccess

QuerySuccess instance


decode

decode(reader, length?): QuerySuccess

Decodes a QuerySuccess message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

QuerySuccess

QuerySuccess

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): QuerySuccess

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

QuerySuccess

QuerySuccess

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIQuerySuccessQuerySuccess message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIQuerySuccessQuerySuccess message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): QuerySuccess

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

QuerySuccess

QuerySuccess


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for QuerySuccess

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageQuerySuccessQuerySuccess
options?IConversionOptionsConversion options

Returns

Object

Plain object