Class: RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
history.v1.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Represents a RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.
Implements
Constructors
constructor
• new RequestCancelExternalWorkflowExecutionInitiatedEventAttributes(properties?): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Constructs a new RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes | Properties to set |
Returns
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Properties
childWorkflowOnly
• childWorkflowOnly: boolean
Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request
Implementation of
IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes.childWorkflowOnly
control
• control: string
Deprecated
Implementation of
IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes.control
namespace
• namespace: string
The namespace the workflow to be cancelled lives in.
SDKs and UI tools should use namespace field but server must use namespace_id only.
Implementation of
IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes.namespace
namespaceId
• namespaceId: string
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes namespaceId.
Implementation of
IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes.namespaceId
reason
• reason: string
Reason for requesting the cancellation
Implementation of
IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes.reason
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes workflowExecution.
Implementation of
IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes.workflowExecution
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Implementation of
IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes.workflowTaskCompletedEventId
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelExternalWorkflowExecutionInitiatedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Creates a new RequestCancelExternalWorkflowExecutionInitiatedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes | Properties to set |
Returns
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes instance
decode
▸ decode(reader, length?): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Decodes a RequestCancelExternalWorkflowExecutionInitiatedEventAttributes 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
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Decodes a RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
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 RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message. Does not implicitly temporal.api.history.v1.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes | RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelExternalWorkflowExecutionInitiatedEventAttributes | RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
Creates a RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
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 RequestCancelExternalWorkflowExecutionInitiatedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelExternalWorkflowExecutionInitiatedEventAttributes | RequestCancelExternalWorkflowExecutionInitiatedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object