temporalio.client

module documentation
(source)

Client for accessing Temporal.

Class AsyncActivityHandle Handle representing an external activity for completion and heartbeat.
Class AsyncActivityIDReference Reference to an async activity by its qualified ID.
Class BackfillScheduleInput Input for OutboundInterceptor.backfill_schedule.
Class BuildIdOp Base class for Build ID operations as used by Client.update_worker_build_id_compatibility.
Class BuildIdOpAddNewCompatible Adds a new Build Id into an existing compatible set. The newly added ID becomes the default for that compatible set, and thus new workflow tasks for workflows which have been executing on workers in that set will now start on this new Build Id.
Class BuildIdOpAddNewDefault Adds a new Build Id into a new set, which will be used as the default set for the queue. This means all new workflows will start on this Build Id.
Class BuildIdOpMergeSets Merges two sets into one set, thus declaring all the Build Ids in both as compatible with one another. The default of the primary set is maintained as the merged set's overall default.
Class BuildIdOpPromoteBuildIdWithinSet Promotes a Build Id within an existing set to become the default ID for that set.
Class BuildIdOpPromoteSetByBuildId Promotes a set of compatible Build Ids to become the current default set for the task queue. Any Build Id in the set may be used to target it.
Class BuildIdReachability Contains information about the reachability of a specific Build ID
Class BuildIdVersionSet A set of Build IDs which are compatible with each other.
Class CancelWorkflowInput Input for OutboundInterceptor.cancel_workflow.
Class Client Client for accessing Temporal.
Class ClientConfig TypedDict of config originally passed to Client.
Class CloudOperationsClient Client for accessing Temporal Cloud Operations API.
Class CompleteAsyncActivityInput Input for OutboundInterceptor.complete_async_activity.
Class CountWorkflowsInput Input for OutboundInterceptor.count_workflows.
Class CreateScheduleInput Input for OutboundInterceptor.create_schedule.
Class DeleteScheduleInput Input for OutboundInterceptor.delete_schedule.
Class DescribeScheduleInput Input for OutboundInterceptor.describe_schedule.
Class DescribeWorkflowInput Input for OutboundInterceptor.describe_workflow.
Class FailAsyncActivityInput Input for OutboundInterceptor.fail_async_activity.
Class FetchWorkflowHistoryEventsInput Input for OutboundInterceptor.fetch_workflow_history_events.
Class GetWorkerBuildIdCompatibilityInput Input for OutboundInterceptor.get_worker_build_id_compatibility.
Class GetWorkerTaskReachabilityInput Input for OutboundInterceptor.get_worker_task_reachability.
Class HeartbeatAsyncActivityInput Input for OutboundInterceptor.heartbeat_async_activity.
Class Interceptor Interceptor for clients.
Class ListSchedulesInput Input for OutboundInterceptor.list_schedules.
Class ListWorkflowsInput Input for OutboundInterceptor.list_workflows.
Class NexusCallback Nexus callback to attach to events such as workflow completion.
Class OutboundInterceptor OutboundInterceptor for intercepting client calls.
Class PauseScheduleInput Input for OutboundInterceptor.pause_schedule.
Class QueryWorkflowInput Input for OutboundInterceptor.query_workflow.
Class ReportCancellationAsyncActivityInput Input for OutboundInterceptor.report_cancellation_async_activity.
Class Schedule A schedule for periodically running an action.
Class ScheduleAction Base class for an action a schedule can take.
Class ScheduleActionExecution Base class for an action execution.
Class ScheduleActionExecutionStartWorkflow Execution of a scheduled workflow start.
Class ScheduleActionResult Information about when an action took place.
Class ScheduleActionStartWorkflow Schedule action to start a workflow.
Class ScheduleAsyncIterator Asynchronous iterator for ScheduleListDescription values.
Class ScheduleBackfill Time period and policy for actions taken as if the time passed right now.
Class ScheduleCalendarSpec Specification relative to calendar time when to run an action.
Class ScheduleDescription Description of a schedule.
Class ScheduleHandle Handle for interacting with a schedule.
Class ScheduleInfo Information about a schedule.
Class ScheduleIntervalSpec Specification for scheduling on an interval.
Class ScheduleListAction Base class for an action a listed schedule can take.
Class ScheduleListActionStartWorkflow Action to start a workflow on a listed schedule.
Class ScheduleListDescription Description of a listed schedule.
Class ScheduleListInfo Information about a listed schedule.
Class ScheduleListSchedule Details for a listed schedule.
Class ScheduleListState State of a listed schedule.
Class ScheduleOverlapPolicy Controls what happens when a workflow would be started by a schedule but one is already running.
Class SchedulePolicy Policies of a schedule.
Class ScheduleRange Inclusive range for a schedule match value.
Class ScheduleSpec Specification of the times scheduled actions may occur.
Class ScheduleState State of a schedule.
Class ScheduleUpdate Result of an update callback for ScheduleHandle.update.
Class ScheduleUpdateInput Parameter for an update callback for ScheduleHandle.update.
Class SignalWorkflowInput Input for OutboundInterceptor.signal_workflow.
Class StartWorkflowInput Input for OutboundInterceptor.start_workflow.
Class StartWorkflowUpdateInput Input for OutboundInterceptor.start_workflow_update.
Class StartWorkflowUpdateWithStartInput Input for OutboundInterceptor.start_update_with_start_workflow.
Class TaskReachabilityType Enumerates how a task might reach certain kinds of workflows
Class TerminateWorkflowInput Input for OutboundInterceptor.terminate_workflow.
Class TriggerScheduleInput Input for OutboundInterceptor.trigger_schedule.
Class UnpauseScheduleInput Input for OutboundInterceptor.unpause_schedule.
Class UpdateScheduleInput Input for OutboundInterceptor.update_schedule.
Class UpdateWithStartStartWorkflowInput StartWorkflow input for OutboundInterceptor.start_update_with_start_workflow.
Class UpdateWithStartUpdateWorkflowInput Update input for OutboundInterceptor.start_update_with_start_workflow.
Class UpdateWorkerBuildIdCompatibilityInput Input for OutboundInterceptor.update_worker_build_id_compatibility.
Class WithStartWorkflowOperation Defines a start-workflow operation used by update-with-start requests.
Class WorkerBuildIdVersionSets Represents the sets of compatible Build ID versions associated with some Task Queue, as fetched by Client.get_worker_build_id_compatibility.
Class WorkerTaskReachability Contains information about the reachability of some Build IDs
Class WorkflowExecution Info for a single workflow execution run.
Class WorkflowExecutionAsyncIterator Asynchronous iterator for WorkflowExecution values.
Class WorkflowExecutionCount Representation of a count from a count workflows call.
Class WorkflowExecutionCountAggregationGroup Aggregation group if the workflow count query had a group-by clause.
Class WorkflowExecutionDescription Description for a single workflow execution run.
Class WorkflowExecutionStatus Status of a workflow execution.
Class WorkflowHandle Handle for interacting with a workflow.
Class WorkflowHistory A workflow's ID and immutable history.
Class WorkflowHistoryEventAsyncIterator Asynchronous iterator for history events of a workflow.
Class WorkflowHistoryEventFilterType Type of history events to get for a workflow.
Class WorkflowUpdateHandle Handle for a workflow update execution request.
Class WorkflowUpdateStage Stage to wait for workflow update to reach before returning from start_update.
Exception AsyncActivityCancelledError Error that occurs when async activity attempted heartbeat but was cancelled.
Exception RPCTimeoutOrCancelledError Error that occurs on some client calls that timeout or get cancelled.
Exception ScheduleAlreadyRunningError Error when a schedule is already running.
Exception WorkflowContinuedAsNewError Error that occurs when a workflow was continued as new.
Exception WorkflowFailureError Error that occurs when a workflow is unsuccessful.
Exception WorkflowQueryFailedError Error that occurs when a query fails.
Exception WorkflowQueryRejectedError Error that occurs when a query was rejected.
Exception WorkflowUpdateFailedError Error that occurs when an update fails.
Exception WorkflowUpdateRPCTimeoutOrCancelledError Error that occurs when update RPC call times out or is cancelled.
Class _ClientImpl Undocumented
Async Function _apply_headers Undocumented
Async Function _decode_user_metadata Returns (summary, details)
Async Function _encode_user_metadata Undocumented
Function _fix_history_enum Undocumented
Function _fix_history_failure Undocumented
Function _history_from_json Undocumented
Variable _pascal_case_match Undocumented
async def _apply_headers(source: Mapping[str, temporalio.api.common.v1.Payload] | None, dest: MessageMap[str, temporalio.api.common.v1.Payload], encode_headers: bool, codec: temporalio.converter.PayloadCodec | None): (source)

Undocumented

async def _decode_user_metadata(converter: temporalio.converter.DataConverter, metadata: temporalio.api.sdk.v1.UserMetadata | None) -> tuple[str | None, str | None]: (source)

Returns (summary, details)

async def _encode_user_metadata(converter: temporalio.converter.DataConverter, summary: str | temporalio.api.common.v1.Payload | None, details: str | temporalio.api.common.v1.Payload | None) -> temporalio.api.sdk.v1.UserMetadata | None: (source)

Undocumented

def _fix_history_enum(prefix: str, parent: dict[str, Any], *attrs: str): (source)

Undocumented

def _fix_history_failure(parent: dict[str, Any], *attrs: str): (source)

Undocumented

def _history_from_json(history: str | dict[str, Any]) -> temporalio.api.history.v1.History: (source)

Undocumented

_pascal_case_match = (source)

Undocumented