Class: RequestCancelNexusOperation
coresdk.workflow_commands.RequestCancelNexusOperation
Request cancellation of a nexus operation started via ScheduleNexusOperation
Implements
Constructors
constructor
• new RequestCancelNexusOperation(properties?): RequestCancelNexusOperation
Constructs a new RequestCancelNexusOperation.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelNexusOperation | Properties to set |
Returns
Properties
seq
• seq: number
Lang's incremental sequence number as passed to ScheduleNexusOperation
Implementation of
IRequestCancelNexusOperation.seq
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelNexusOperation to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelNexusOperation
Creates a new RequestCancelNexusOperation instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelNexusOperation | Properties to set |
Returns
RequestCancelNexusOperation instance
decode
▸ decode(reader, length?): RequestCancelNexusOperation
Decodes a RequestCancelNexusOperation 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
RequestCancelNexusOperation
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelNexusOperation
Decodes a RequestCancelNexusOperation message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestCancelNexusOperation
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 RequestCancelNexusOperation message. Does not implicitly coresdk.workflow_commands.RequestCancelNexusOperation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelNexusOperation | RequestCancelNexusOperation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelNexusOperation message, length delimited. Does not implicitly coresdk.workflow_commands.RequestCancelNexusOperation.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelNexusOperation | RequestCancelNexusOperation message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelNexusOperation
Creates a RequestCancelNexusOperation message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelNexusOperation
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RequestCancelNexusOperation
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 RequestCancelNexusOperation message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelNexusOperation | RequestCancelNexusOperation |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object