Class: ExternalWorkflowExecutionCancelRequestedEventAttributes
history.v1.ExternalWorkflowExecutionCancelRequestedEventAttributes
Represents an ExternalWorkflowExecutionCancelRequestedEventAttributes.
Implements
Constructors
constructor
• new ExternalWorkflowExecutionCancelRequestedEventAttributes(properties?): ExternalWorkflowExecutionCancelRequestedEventAttributes
Constructs a new ExternalWorkflowExecutionCancelRequestedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IExternalWorkflowExecutionCancelRequestedEventAttributes | Properties to set |
Returns
ExternalWorkflowExecutionCancelRequestedEventAttributes
Properties
initiatedEventId
• initiatedEventId: Long
id of the REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_INITIATED event this event corresponds
to
Implementation of
IExternalWorkflowExecutionCancelRequestedEventAttributes.initiatedEventId
namespace
• namespace: string
Namespace of the to-be-cancelled workflow.
SDKs and UI tools should use namespace field but server must use namespace_id only.
Implementation of
IExternalWorkflowExecutionCancelRequestedEventAttributes.namespace
namespaceId
• namespaceId: string
ExternalWorkflowExecutionCancelRequestedEventAttributes namespaceId.
Implementation of
IExternalWorkflowExecutionCancelRequestedEventAttributes.namespaceId
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
ExternalWorkflowExecutionCancelRequestedEventAttributes workflowExecution.
Implementation of
IExternalWorkflowExecutionCancelRequestedEventAttributes.workflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this ExternalWorkflowExecutionCancelRequestedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ExternalWorkflowExecutionCancelRequestedEventAttributes
Creates a new ExternalWorkflowExecutionCancelRequestedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IExternalWorkflowExecutionCancelRequestedEventAttributes | Properties to set |
Returns
ExternalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequestedEventAttributes instance
decode
▸ decode(reader, length?): ExternalWorkflowExecutionCancelRequestedEventAttributes
Decodes an ExternalWorkflowExecutionCancelRequestedEventAttributes 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
ExternalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequestedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ExternalWorkflowExecutionCancelRequestedEventAttributes
Decodes an ExternalWorkflowExecutionCancelRequestedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ExternalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequestedEventAttributes
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 ExternalWorkflowExecutionCancelRequestedEventAttributes message. Does not implicitly temporal.api.history.v1.ExternalWorkflowExecutionCancelRequestedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IExternalWorkflowExecutionCancelRequestedEventAttributes | ExternalWorkflowExecutionCancelRequestedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ExternalWorkflowExecutionCancelRequestedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.ExternalWorkflowExecutionCancelRequestedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IExternalWorkflowExecutionCancelRequestedEventAttributes | ExternalWorkflowExecutionCancelRequestedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ExternalWorkflowExecutionCancelRequestedEventAttributes
Creates an ExternalWorkflowExecutionCancelRequestedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ExternalWorkflowExecutionCancelRequestedEventAttributes
ExternalWorkflowExecutionCancelRequestedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ExternalWorkflowExecutionCancelRequestedEventAttributes
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 an ExternalWorkflowExecutionCancelRequestedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ExternalWorkflowExecutionCancelRequestedEventAttributes | ExternalWorkflowExecutionCancelRequestedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object