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