Class: OnConflictOptions
When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and there is already an existing running workflow, OnConflictOptions defines actions to be taken on the existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent history event in the running workflow with the changes requested in this object.
Implements
Constructors
constructor
• new OnConflictOptions(properties?): OnConflictOptions
Constructs a new OnConflictOptions.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOnConflictOptions | Properties to set |
Returns
Properties
attachCompletionCallbacks
• attachCompletionCallbacks: boolean
Attaches the completion callbacks to the running workflow.
Implementation of
IOnConflictOptions.attachCompletionCallbacks
attachLinks
• attachLinks: boolean
Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
Implementation of
IOnConflictOptions.attachLinks
attachRequestId
• attachRequestId: boolean
Attaches the request ID to the running workflow.
Implementation of
IOnConflictOptions.attachRequestId
Methods
toJSON
▸ toJSON(): Object
Converts this OnConflictOptions to JSON.
Returns
Object
JSON object
create
▸ create(properties?): OnConflictOptions
Creates a new OnConflictOptions instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IOnConflictOptions | Properties to set |
Returns
OnConflictOptions instance
decode
▸ decode(reader, length?): OnConflictOptions
Decodes an OnConflictOptions 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
OnConflictOptions
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): OnConflictOptions
Decodes an OnConflictOptions message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
OnConflictOptions
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 OnConflictOptions message. Does not implicitly temporal.api.workflow.v1.OnConflictOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOnConflictOptions | OnConflictOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified OnConflictOptions message, length delimited. Does not implicitly temporal.api.workflow.v1.OnConflictOptions.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IOnConflictOptions | OnConflictOptions message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): OnConflictOptions
Creates an OnConflictOptions message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
OnConflictOptions
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for OnConflictOptions
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 OnConflictOptions message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | OnConflictOptions | OnConflictOptions |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object