Class: WorkflowExecutionCancelRequestedEventAttributes
history.v1.WorkflowExecutionCancelRequestedEventAttributes
Represents a WorkflowExecutionCancelRequestedEventAttributes.
Implements
Constructors
constructor
• new WorkflowExecutionCancelRequestedEventAttributes(properties?): WorkflowExecutionCancelRequestedEventAttributes
Constructs a new WorkflowExecutionCancelRequestedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionCancelRequestedEventAttributes | Properties to set |
Returns
WorkflowExecutionCancelRequestedEventAttributes
Properties
cause
• cause: string
User provided reason for requesting cancellation TODO: shall we create a new field with name "reason" and deprecate this one?
Implementation of
IWorkflowExecutionCancelRequestedEventAttributes.cause
externalInitiatedEventId
• externalInitiatedEventId: Long
TODO: Is this the ID of the event in the workflow which initiated this cancel, if there was one?
Implementation of
IWorkflowExecutionCancelRequestedEventAttributes.externalInitiatedEventId
externalWorkflowExecution
• Optional externalWorkflowExecution: null | IWorkflowExecution
WorkflowExecutionCancelRequestedEventAttributes externalWorkflowExecution.
Implementation of
IWorkflowExecutionCancelRequestedEventAttributes.externalWorkflowExecution
identity
• identity: string
id of the worker or client who requested this cancel
Implementation of
IWorkflowExecutionCancelRequestedEventAttributes.identity
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionCancelRequestedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionCancelRequestedEventAttributes
Creates a new WorkflowExecutionCancelRequestedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionCancelRequestedEventAttributes | Properties to set |
Returns
WorkflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequestedEventAttributes instance
decode
▸ decode(reader, length?): WorkflowExecutionCancelRequestedEventAttributes
Decodes a WorkflowExecutionCancelRequestedEventAttributes 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
WorkflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequestedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionCancelRequestedEventAttributes
Decodes a WorkflowExecutionCancelRequestedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequestedEventAttributes
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 WorkflowExecutionCancelRequestedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionCancelRequestedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionCancelRequestedEventAttributes | WorkflowExecutionCancelRequestedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionCancelRequestedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionCancelRequestedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionCancelRequestedEventAttributes | WorkflowExecutionCancelRequestedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionCancelRequestedEventAttributes
Creates a WorkflowExecutionCancelRequestedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionCancelRequestedEventAttributes
WorkflowExecutionCancelRequestedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowExecutionCancelRequestedEventAttributes
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 WorkflowExecutionCancelRequestedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionCancelRequestedEventAttributes | WorkflowExecutionCancelRequestedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object