Skip to main content

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.

Properties​

attachCompletionCallbacks​

attachCompletionCallbacks: boolean

Attaches the completion callbacks to the running workflow.

attachLinks: boolean

Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.

attachRequestId​

attachRequestId: boolean

Attaches the request ID to the running workflow.

Methods​

toJSON()​

toJSON(): object

Converts this OnConflictOptions to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): OnConflictOptions & $Properties

Creates a new OnConflictOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

OnConflictOptions & $Properties

OnConflictOptions instance

Call Signature​

static create(properties?): OnConflictOptions

Creates a new OnConflictOptions instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

OnConflictOptions

OnConflictOptions instance

decode()​

static decode(reader, length?): OnConflictOptions & $Properties

Decodes an OnConflictOptions message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

OnConflictOptions & $Properties

OnConflictOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): OnConflictOptions & $Properties

Decodes an OnConflictOptions message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

OnConflictOptions & $Properties

OnConflictOptions

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified OnConflictOptions message. Does not implicitly temporal.api.workflow.v1.OnConflictOptions.verify|verify messages.

Parameters​

message​

$Properties

OnConflictOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified OnConflictOptions message, length delimited. Does not implicitly temporal.api.workflow.v1.OnConflictOptions.verify|verify messages.

Parameters​

message​

$Properties

OnConflictOptions message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): OnConflictOptions

Creates an OnConflictOptions message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

OnConflictOptions

OnConflictOptions

toObject()​

static toObject(message, options?): object

Creates a plain object from an OnConflictOptions message. Also converts values to other types if specified.

Parameters​

message​

OnConflictOptions

OnConflictOptions

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object