Skip to main content

Class: WorkflowExecutionFilter

Represents a WorkflowExecutionFilter.

Properties​

runId​

runId: string

WorkflowExecutionFilter runId.

workflowId​

workflowId: string

WorkflowExecutionFilter workflowId.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowExecutionFilter to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowExecutionFilter & $Properties

Creates a new WorkflowExecutionFilter instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionFilter & $Properties

WorkflowExecutionFilter instance

Call Signature​

static create(properties?): WorkflowExecutionFilter

Creates a new WorkflowExecutionFilter instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowExecutionFilter

WorkflowExecutionFilter instance

decode()​

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

Decodes a WorkflowExecutionFilter 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​

WorkflowExecutionFilter & $Properties

WorkflowExecutionFilter

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowExecutionFilter & $Properties

Decodes a WorkflowExecutionFilter message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowExecutionFilter & $Properties

WorkflowExecutionFilter

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 WorkflowExecutionFilter message. Does not implicitly temporal.api.filter.v1.WorkflowExecutionFilter.verify|verify messages.

Parameters​

message​

$Properties

WorkflowExecutionFilter message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowExecutionFilter message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowExecutionFilter

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

Parameters​

object​

Plain object

Returns​

WorkflowExecutionFilter

WorkflowExecutionFilter

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowExecutionFilter

WorkflowExecutionFilter

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object