Skip to main content

Class: Operation

Represents an Operation.

Properties​

operation?​

optional operation?: "startWorkflow" | "updateWorkflow"

Operation operation.

startWorkflow?​

optional startWorkflow?: $Properties | null

Additional restrictions:

  • setting cron_schedule is invalid
  • setting request_eager_execution is invalid
  • setting workflow_start_delay is invalid

updateWorkflow?​

optional updateWorkflow?: $Properties | null

Additional restrictions:

  • setting first_execution_run_id is invalid
  • setting workflow_execution.run_id is invalid

Methods​

toJSON()​

toJSON(): object

Converts this Operation to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Operation & $Shape

Creates a new Operation instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Operation & $Shape

Operation instance

Call Signature​

static create(properties?): Operation

Creates a new Operation instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Operation

Operation instance

decode()​

static decode(reader, length?): Operation & $Shape

Decodes an Operation 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​

Operation & $Shape

Operation

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Operation & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Operation & $Shape

Operation

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 Operation message. Does not implicitly temporal.api.workflowservice.v1.ExecuteMultiOperationRequest.Operation.verify|verify messages.

Parameters​

message​

$Properties

Operation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Operation message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ExecuteMultiOperationRequest.Operation.verify|verify messages.

Parameters​

message​

$Properties

Operation message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Operation

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

Parameters​

object​

Plain object

Returns​

Operation

Operation

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Operation

Operation

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object