Class: QuerySuccess
coresdk.workflow_commands.QuerySuccess
Represents a QuerySuccess.
Implements
Constructors
constructor
• new QuerySuccess(properties?): QuerySuccess
Constructs a new QuerySuccess.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IQuerySuccess | Properties to set |
Returns
Properties
response
• Optional response: null | IPayload
QuerySuccess response.
Implementation of
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
| Name | Type | Description |
|---|---|---|
properties? | IQuerySuccess | Properties to set |
Returns
QuerySuccess instance
decode
▸ decode(reader, length?): QuerySuccess
Decodes a QuerySuccess 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
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IQuerySuccess | QuerySuccess message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IQuerySuccess | QuerySuccess message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
QuerySuccess
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for QuerySuccess
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your 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
| Name | Type | Description |
|---|---|---|
message | QuerySuccess | QuerySuccess |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object