class documentation

Description of a listed schedule.

Async Method memo Schedule's memo values, converted without type hints.
Async Method memo_value Memo value for the given key, optional default, and optional type hint.
Class Variable data_converter Data converter used for memo decoding.
Class Variable id ID of the schedule.
Class Variable info Information about the schedule.
Class Variable raw_entry Raw description of the schedule.
Class Variable schedule Schedule details that can be mutated.
Class Variable search_attributes Search attributes on the schedule.
Class Variable typed_search_attributes Search attributes on the schedule.
Static Method _from_proto Undocumented
async def memo(self) -> Mapping[str, Any]: (source)

Schedule's memo values, converted without type hints.

Since type hints are not used, the default converted values will come back. For example, if the memo was originally created with a dataclass, the value will be a dict. To convert using proper type hints, use memo_value.

Returns
Mapping[str, Any]Mapping of all memo keys and they values without type hints.
@overload
async def memo_value(self, key: str, default: Any = temporalio.common._arg_unset) -> Any:
@overload
async def memo_value(self, key: str, *, type_hint: Type[ParamType]) -> ParamType:
@overload
async def memo_value(self, key: str, default: AnyType, *, type_hint: Type[ParamType]) -> Union[AnyType, ParamType]:
(source)

Memo value for the given key, optional default, and optional type hint.

Parameters
key:strKey to get memo value for.
default:AnyDefault to use if key is not present. If unset, a KeyError is raised when the key does not exist.
type_hint:Optional[Type]Type hint to use when converting.
Returns
AnyMemo value, converted with the type hint if present.
Raises
KeyErrorKey not present and default not set.

Data converter used for memo decoding.

ID of the schedule.

Information about the schedule.

This may not be present in older Temporal servers without advanced visibility.

Raw description of the schedule.

Schedule details that can be mutated.

This may not be present in older Temporal servers without advanced visibility.

Search attributes on the schedule.

Deprecated since version Use: typed_search_attributes instead.

Search attributes on the schedule.