Skip to main content

Class: StatusFilter

filter.v1.StatusFilter

Represents a StatusFilter.

Implements#

Constructors#

constructor#

new StatusFilter(properties?)

Constructs a new StatusFilter.

Parameters#

NameType
properties?IStatusFilter

Properties#

status#

status: WorkflowExecutionStatus

StatusFilter status.

Implementation of#

IStatusFilter.status

Methods#

toJSON#

toJSON(): Object

Converts this StatusFilter to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): StatusFilter

Decodes a StatusFilter message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

StatusFilter

StatusFilter


decodeDelimited#

Static decodeDelimited(reader): StatusFilter

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

StatusFilter

StatusFilter


encode#

Static encode(message, writer?): Writer

Encodes the specified StatusFilter message. Does not implicitly {@link temporal.api.filter.v1.StatusFilter.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStatusFilterStatusFilter message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified StatusFilter message, length delimited. Does not implicitly {@link temporal.api.filter.v1.StatusFilter.verify|verify} messages.

Parameters#

NameTypeDescription
messageIStatusFilterStatusFilter message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): StatusFilter

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

StatusFilter

StatusFilter


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageStatusFilterStatusFilter
options?IConversionOptions-

Returns#

Object

Plain object