Class: WorkflowExecutionFailedEventAttributes
history.v1.WorkflowExecutionFailedEventAttributes
Represents a WorkflowExecutionFailedEventAttributes.
Implements
Constructors
constructor
• new WorkflowExecutionFailedEventAttributes(properties?): WorkflowExecutionFailedEventAttributes
Constructs a new WorkflowExecutionFailedEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionFailedEventAttributes | Properties to set |
Returns
WorkflowExecutionFailedEventAttributes
Properties
failure
• Optional failure: null | IFailure
Serialized result of workflow failure (ex: An exception thrown, or error returned)
Implementation of
IWorkflowExecutionFailedEventAttributes.failure
newExecutionRunId
• newExecutionRunId: string
If another run is started by cron or retry, this contains the new run id.
Implementation of
IWorkflowExecutionFailedEventAttributes.newExecutionRunId
retryState
• retryState: RetryState
WorkflowExecutionFailedEventAttributes retryState.
Implementation of
IWorkflowExecutionFailedEventAttributes.retryState
workflowTaskCompletedEventId
• workflowTaskCompletedEventId: Long
The WORKFLOW_TASK_COMPLETED event which this command was reported with
Implementation of
IWorkflowExecutionFailedEventAttributes.workflowTaskCompletedEventId
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionFailedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionFailedEventAttributes
Creates a new WorkflowExecutionFailedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionFailedEventAttributes | Properties to set |
Returns
WorkflowExecutionFailedEventAttributes
WorkflowExecutionFailedEventAttributes instance
decode
▸ decode(reader, length?): WorkflowExecutionFailedEventAttributes
Decodes a WorkflowExecutionFailedEventAttributes 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
WorkflowExecutionFailedEventAttributes
WorkflowExecutionFailedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionFailedEventAttributes
Decodes a WorkflowExecutionFailedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionFailedEventAttributes
WorkflowExecutionFailedEventAttributes
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 WorkflowExecutionFailedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionFailedEventAttributes | WorkflowExecutionFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionFailedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionFailedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionFailedEventAttributes | WorkflowExecutionFailedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionFailedEventAttributes
Creates a WorkflowExecutionFailedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionFailedEventAttributes
WorkflowExecutionFailedEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowExecutionFailedEventAttributes
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 WorkflowExecutionFailedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionFailedEventAttributes | WorkflowExecutionFailedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object