Class: WorkflowExecutionTerminatedEventAttributes
history.v1.WorkflowExecutionTerminatedEventAttributes
Represents a WorkflowExecutionTerminatedEventAttributes.
Properties
details
• Optional details: null | $Properties
WorkflowExecutionTerminatedEventAttributes details.
identity
• identity: string
id of the client who requested termination
reason
• reason: string
User/client provided reason for termination
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionTerminatedEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionTerminatedEventAttributes & $Properties
Creates a new WorkflowExecutionTerminatedEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowExecutionTerminatedEventAttributes & $Properties
WorkflowExecutionTerminatedEventAttributes instance
▸ create(properties?): WorkflowExecutionTerminatedEventAttributes
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
WorkflowExecutionTerminatedEventAttributes
decode
▸ decode(reader, length?): WorkflowExecutionTerminatedEventAttributes & $Properties
Decodes a WorkflowExecutionTerminatedEventAttributes 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
WorkflowExecutionTerminatedEventAttributes & $Properties
WorkflowExecutionTerminatedEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionTerminatedEventAttributes & $Properties
Decodes a WorkflowExecutionTerminatedEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionTerminatedEventAttributes & $Properties
WorkflowExecutionTerminatedEventAttributes
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 WorkflowExecutionTerminatedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionTerminatedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionTerminatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionTerminatedEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionTerminatedEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionTerminatedEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionTerminatedEventAttributes
Creates a WorkflowExecutionTerminatedEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionTerminatedEventAttributes
WorkflowExecutionTerminatedEventAttributes
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecutionTerminatedEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionTerminatedEventAttributes | WorkflowExecutionTerminatedEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object