Class: CancelNexusTask
Represents a CancelNexusTask.
Properties
reason
• reason: NexusTaskCancelReason
Why Core is asking for this operation to be cancelled
taskToken
• taskToken: Uint8Array
The task token from the PollNexusTaskQueueResponse
Methods
toJSON
▸ toJSON(): Object
Converts this CancelNexusTask to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelNexusTask & $Properties
Creates a new CancelNexusTask instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CancelNexusTask instance
▸ create(properties?): CancelNexusTask
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CancelNexusTask & $Properties
Decodes a CancelNexusTask 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
CancelNexusTask
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelNexusTask & $Properties
Decodes a CancelNexusTask message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelNexusTask
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 CancelNexusTask message. Does not implicitly coresdk.nexus.CancelNexusTask.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelNexusTask message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelNexusTask message, length delimited. Does not implicitly coresdk.nexus.CancelNexusTask.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CancelNexusTask message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelNexusTask
Creates a CancelNexusTask message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelNexusTask
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CancelNexusTask message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelNexusTask | CancelNexusTask |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object