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.

Static Method for_bool Create a 'Bool' search attribute type.
Static Method for_datetime Create a 'Datetime' search attribute type.
Static Method for_float Create a 'Double' search attribute type.
Static Method for_int Create an 'Int' search attribute type.
Static Method for_keyword Create a 'Keyword' search attribute type.
Static Method for_keyword_list Create a 'KeywordList' search attribute type.
Static Method for_text Create a 'Text' search attribute type.
Method value_set Create a search attribute update to set the given value on this key.
Method value_unset Create a search attribute update to unset the value on this key.
Property indexed_value_type Get the server index typed of the key
Property name Get the name of the key.
Property origin_value_type Get the Python type of value for the key without generics.
Property value_type Get the Python type of value for the key.
Static Method _from_metadata_type Undocumented
Static Method _guess_from_untyped_values Undocumented
Property _metadata_type Undocumented
@staticmethod
def for_bool(name: str) -> SearchAttributeKey[bool]: (source)

Create a 'Bool' search attribute type.

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

Create a 'Datetime' search attribute type.

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

Create a 'Double' search attribute type.

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

Create an 'Int' search attribute type.

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

Create a 'Keyword' search attribute type.

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

Create a 'KeywordList' search attribute type.

@staticmethod
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.

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

Get the server index typed of the key

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

Get the name of the key.

@property
origin_value_type: Type = (source)

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

@property
@abstractmethod
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.

@staticmethod
def _from_metadata_type(name: str, metadata_type: str) -> Optional[SearchAttributeKey]: (source)

Undocumented

@staticmethod
def _guess_from_untyped_values(name: str, vals: SearchAttributeValues) -> Optional[SearchAttributeKey]: (source)

Undocumented

@property
_metadata_type: str = (source)

Undocumented