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