Skip to main content

Class: SearchAttributes

common.v1.SearchAttributes

Represents a SearchAttributes.

Implements

Constructors

constructor

new SearchAttributes(properties?)

Constructs a new SearchAttributes.

Parameters

NameTypeDescription
properties?ISearchAttributesProperties to set

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


create

Static create(properties?): SearchAttributes

Creates a new SearchAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?ISearchAttributesProperties to set

Returns

SearchAttributes

SearchAttributes instance


decode

Static decode(reader, length?): SearchAttributes

Decodes a SearchAttributes message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

SearchAttributes

SearchAttributes


decodeDelimited

Static decodeDelimited(reader): SearchAttributes

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

Throws

If the payload is not a reader or valid buffer

Throws

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

Parameters

NameTypeDescription
messageISearchAttributesSearchAttributes message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageISearchAttributesSearchAttributes message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

SearchAttributes

SearchAttributes


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for SearchAttributes

Parameters

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

Returns

string

The default type url


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?IConversionOptionsConversion options

Returns

Object

Plain object