Skip to main content

Class: StatusFilter

filter.v1.StatusFilter

Represents a StatusFilter.

Implements

Constructors

constructor

new StatusFilter(properties?): StatusFilter

Constructs a new StatusFilter.

Parameters

NameTypeDescription
properties?IStatusFilterProperties to set

Returns

StatusFilter

Properties

status

status: WorkflowExecutionStatus

StatusFilter status.

Implementation of

IStatusFilter.status

Methods

toJSON

toJSON(): Object

Converts this StatusFilter to JSON.

Returns

Object

JSON object


create

create(properties?): StatusFilter

Creates a new StatusFilter instance using the specified properties.

Parameters

NameTypeDescription
properties?IStatusFilterProperties to set

Returns

StatusFilter

StatusFilter instance


decode

decode(reader, length?): StatusFilter

Decodes a StatusFilter message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

StatusFilter

StatusFilter

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): StatusFilter

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

StatusFilter

StatusFilter

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

Parameters

NameTypeDescription
messageIStatusFilterStatusFilter message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIStatusFilterStatusFilter message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StatusFilter

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageStatusFilterStatusFilter
options?IConversionOptionsConversion options

Returns

Object

Plain object