temporalio.common.SearchAttributeKey

temporalio.common.SearchAttributeKey

class documentation

class SearchAttributeKey(ABC, Generic[SearchAttributeValueType]): (source)

Known subclasses: temporalio.common._SearchAttributeKey

View In Hierarchy

Typed search attribute key representation.

Use one of the for static methods here to create a key.

def for_bool(name: str) -> SearchAttributeKey[bool]: (source)

Create a 'Bool' search attribute type.

def for_datetime(name: str) -> SearchAttributeKey[datetime]: (source)

Create a 'Datetime' search attribute type.

def for_float(name: str) -> SearchAttributeKey[float]: (source)

Create a 'Double' search attribute type.

def for_int(name: str) -> SearchAttributeKey[int]: (source)

Create an 'Int' search attribute type.

def for_keyword(name: str) -> SearchAttributeKey[str]: (source)

Create a 'Keyword' search attribute type.

def for_keyword_list(name: str) -> SearchAttributeKey[Sequence[str]]: (source)

Create a 'KeywordList' search attribute type.

def for_text(name: str) -> SearchAttributeKey[str]: (source)

Create a 'Text' search attribute type.

def value_set(self, value: SearchAttributeValueType) -> SearchAttributeUpdate[SearchAttributeValueType]: (source)

Create a search attribute update to set the given value on this key.

def value_unset(self) -> SearchAttributeUpdate[SearchAttributeValueType]: (source)

Create a search attribute update to unset the value on this key.

indexed_value_type: SearchAttributeIndexedValueType = (source)
overridden in temporalio.common._SearchAttributeKey

Get the server index typed of the key

name: str = (source)
overridden in temporalio.common._SearchAttributeKey

Get the name of the key.

origin_value_type: type = (source)

Get the Python type of value for the key without generics.

value_type: type[SearchAttributeValueType] = (source)
overridden in temporalio.common._SearchAttributeKey

Get the Python type of value for the key.

This may contain generics which cannot be used in isinstance. origin_value_type can be used instead.

def _from_metadata_type(name: str, metadata_type: str) -> SearchAttributeKey | None: (source)

Undocumented

def _guess_from_untyped_values(name: str, vals: SearchAttributeValues) -> SearchAttributeKey | None: (source)

Undocumented

_metadata_type: str = (source)

Undocumented