Skip to main content

Class: WorkflowExecutionFilter

filter.v1.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

create(properties?): WorkflowExecutionFilter & $Properties

Creates a new WorkflowExecutionFilter instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

WorkflowExecutionFilter & $Properties

WorkflowExecutionFilter instance

create(properties?): WorkflowExecutionFilter

Parameters

NameType
properties?$Properties

Returns

WorkflowExecutionFilter


decode

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

Decodes a WorkflowExecutionFilter message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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

decodeDelimited(reader): WorkflowExecutionFilter & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader 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

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesWorkflowExecutionFilter message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesWorkflowExecutionFilter message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): WorkflowExecutionFilter

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkflowExecutionFilter

WorkflowExecutionFilter


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageWorkflowExecutionFilterWorkflowExecutionFilter
options?IConversionOptionsConversion options

Returns

Object

Plain object