Skip to main content

Class: SearchAttributes

common.v1.SearchAttributes

Represents a SearchAttributes.

Implements#

Constructors#

constructor#

new SearchAttributes(properties?)

Constructs a new SearchAttributes.

Parameters#

NameType
properties?ISearchAttributes

Properties#

indexedFields#

indexedFields: Object

SearchAttributes indexedFields.

Index signature#

▪ [k: string]: IPayload

Implementation of#

ISearchAttributes.indexedFields

Methods#

toJSON#

toJSON(): Object

Converts this SearchAttributes to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): SearchAttributes

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

SearchAttributes

SearchAttributes


decodeDelimited#

Static decodeDelimited(reader): SearchAttributes

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

SearchAttributes

SearchAttributes


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

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#

NameTypeDescription
objectObjectPlain 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#

NameTypeDescription
messageSearchAttributesSearchAttributes
options?IConversionOptions-

Returns#

Object

Plain object