Class: CancelOperationRequest
nexus.v1.CancelOperationRequest
A request to cancel an operation.
Implements
Constructors
constructor
• new CancelOperationRequest(properties?): CancelOperationRequest
Constructs a new CancelOperationRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelOperationRequest | Properties to set |
Returns
Properties
operation
• operation: string
Type of operation to cancel.
Implementation of
ICancelOperationRequest.operation
operationId
• operationId: string
Operation ID as originally generated by a Handler.
Deprecated. Renamed to operation_token.
Implementation of
ICancelOperationRequest.operationId
operationToken
• operationToken: string
Operation token as originally generated by a Handler.
Implementation of
ICancelOperationRequest.operationToken
service
• service: string
Service name.
Implementation of
ICancelOperationRequest.service
Methods
toJSON
▸ toJSON(): Object
Converts this CancelOperationRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelOperationRequest
Creates a new CancelOperationRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelOperationRequest | Properties to set |
Returns
CancelOperationRequest instance
decode
▸ decode(reader, length?): CancelOperationRequest
Decodes a CancelOperationRequest 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
CancelOperationRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelOperationRequest
Decodes a CancelOperationRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelOperationRequest
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 CancelOperationRequest message. Does not implicitly temporal.api.nexus.v1.CancelOperationRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelOperationRequest | CancelOperationRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelOperationRequest message, length delimited. Does not implicitly temporal.api.nexus.v1.CancelOperationRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelOperationRequest | CancelOperationRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelOperationRequest
Creates a CancelOperationRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelOperationRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CancelOperationRequest
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 CancelOperationRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelOperationRequest | CancelOperationRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object