Skip to main content

Class: SearchAttributes

A user-defined set of indexed fields that are used/exposed when listing/searching workflows. The payload is not serialized in a user-defined way.

Properties​

indexedFields​

indexedFields: object

SearchAttributes indexedFields.

Index Signature​

[k: string]: $Properties

Methods​

toJSON()​

toJSON(): object

Converts this SearchAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SearchAttributes & $Properties

Creates a new SearchAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SearchAttributes & $Properties

SearchAttributes instance

Call Signature​

static create(properties?): SearchAttributes

Creates a new SearchAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SearchAttributes

SearchAttributes instance

decode()​

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

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

SearchAttributes & $Properties

SearchAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SearchAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SearchAttributes & $Properties

SearchAttributes

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

Parameters​

message​

$Properties

SearchAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SearchAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SearchAttributes

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

SearchAttributes

SearchAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SearchAttributes

SearchAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object