Class: QueryResult
coresdk.workflow_commands.QueryResult
Represents a QueryResult.
Properties
failed
• Optional failed: null | $Properties
QueryResult failed.
queryId
• queryId: string
Corresponds to the id provided in the activation job
succeeded
• Optional succeeded: null | $Properties
QueryResult succeeded.
variant
• Optional variant: "failed" | "succeeded"
QueryResult variant.
Methods
toJSON
▸ toJSON(): Object
Converts this QueryResult to JSON.
Returns
Object
JSON object
create
▸ create(properties?): QueryResult & $Shape
Creates a new QueryResult instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
QueryResult instance
▸ create(properties?): QueryResult
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): QueryResult & $Shape
Decodes a QueryResult message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
QueryResult
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): QueryResult & $Shape
Decodes a QueryResult message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
QueryResult
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 QueryResult message. Does not implicitly coresdk.workflow_commands.QueryResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | QueryResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified QueryResult message, length delimited. Does not implicitly coresdk.workflow_commands.QueryResult.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | QueryResult message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): QueryResult
Creates a QueryResult message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
QueryResult
toObject
▸ toObject(message, options?): Object
Creates a plain object from a QueryResult message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | QueryResult | QueryResult |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object