temporalio.client.ScheduleDescription

class documentation

class ScheduleDescription: (source)

Constructor: ScheduleDescription._from_proto(id, desc, converter)

Description of a 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_description`	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]) -> AnyType | ParamType:

(source) ¶

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

Parameters
key:`str`	Key to get memo value for.
default:`Any`	Default to use if key is not present. If unset, a `KeyError` is raised when the key does not exist.
type_hint:`type \| None`	Type hint to use when converting.
Returns
`Any`	Memo value, converted with the type hint if present.
Raises
`KeyError`	Key not present and default not set.

data_converter: temporalio.converter.DataConverter = (source) ¶

Data converter used for memo decoding.

id: str = (source) ¶

ID of the schedule.

info: ScheduleInfo = (source) ¶

Information about the schedule.

raw_description: temporalio.api.workflowservice.v1.DescribeScheduleResponse = (source) ¶

Raw description of the schedule.

schedule: Schedule = (source) ¶

Schedule details that can be mutated.

search_attributes: temporalio.common.SearchAttributes = (source) ¶

Search attributes on the schedule.

Deprecated since version Use: typed_search_attributes instead.

typed_search_attributes: temporalio.common.TypedSearchAttributes = (source) ¶

Search attributes on the schedule.

@staticmethod
def _from_proto(id: str, desc: temporalio.api.workflowservice.v1.DescribeScheduleResponse, converter: temporalio.converter.DataConverter) -> ScheduleDescription: (source) ¶

Undocumented