Temporal Python API Documentation Modules Classes Names

search in docstrings

For more information on the search, visit the help page.

Module _client

Package client

Modules

_activity
_callback
_client
_cloud
_exceptions
_helpers
_impl
_interceptor
_plugin
_schedule
_worker_versioning
_workflow

Classes

ActivityExecution
Methods
- _from_raw_info
Attributes
- activity_id
- activity_run_id
- activity_type
- close_time
- execution_duration
- namespace
- raw_info
- scheduled_time
- state_transition_count
- status
- task_queue
- typed_search_attributes
ActivityExecutionAsyncIterator
Methods
- __aiter__
- __anext__
- __init__
- fetch_next_page
Attributes
- current_page
- current_page_index
- next_page_token
- _client
- _current_page
- _current_page_index
- _input
- _limit
- _next_page_token
- _yielded
ActivityExecutionCount
Methods
- _from_raw
Attributes
- count
- groups
ActivityExecutionCountAggregationGroup
Methods
- _from_raw
Attributes
- count
- group_values
ActivityExecutionDescription
Methods
- _from_execution_info
Inherited Methods
- _from_raw_info
Attributes
- attempt
- canceled_reason
- current_retry_interval
- eager_execution_requested
- expiration_time
- last_attempt_complete_time
- last_failure
- last_heartbeat_time
- last_started_time
- last_worker_identity
- long_poll_token
- next_attempt_schedule_time
- paused
- raw_heartbeat_details
- retry_policy
- run_state
Inherited Attributes
- activity_id
- activity_run_id
- activity_type
- close_time
- execution_duration
- namespace
- raw_info
- scheduled_time
- state_transition_count
- status
- task_queue
- typed_search_attributes
ActivityExecutionStatus
Attributes
- CANCELED
- COMPLETED
- FAILED
- RUNNING
- TERMINATED
- TIMED_OUT
- UNSPECIFIED
ActivityHandle
Methods
- __init__
- cancel
- describe
- result
- terminate
- _poll_until_outcome
Attributes
- id
- run_id
- _client
- _id
- _known_outcome
- _result_type
- _run_id
- _data_converter
AsyncActivityHandle
Methods
- __init__
- complete
- fail
- heartbeat
- report_cancellation
- with_context
Attributes
- _client
- _data_converter_override
- _id_or_token
AsyncActivityIDReference
Attributes
- activity_id
- run_id
- workflow_id
BackfillScheduleInput
Attributes
- backfills
- id
- rpc_metadata
- rpc_timeout
BuildIdOp
Methods
- _as_partial_proto
BuildIdOpAddNewCompatible
Methods
- _as_partial_proto
Attributes
- build_id
- existing_compatible_build_id
- promote_set
BuildIdOpAddNewDefault
Methods
- _as_partial_proto
Attributes
- build_id
BuildIdOpMergeSets
Methods
- _as_partial_proto
Attributes
- primary_build_id
- secondary_build_id
BuildIdOpPromoteBuildIdWithinSet
Methods
- _as_partial_proto
Attributes
- build_id
BuildIdOpPromoteSetByBuildId
Methods
- _as_partial_proto
Attributes
- build_id
BuildIdReachability
Attributes
- task_queue_reachability
- unretrieved_task_queues
BuildIdVersionSet
Methods
- default
Attributes
- build_ids
CancelActivityInput
Attributes
- activity_id
- activity_run_id
- reason
- rpc_metadata
- rpc_timeout
CancelWorkflowInput
Attributes
- first_execution_run_id
- id
- rpc_metadata
- rpc_timeout
- run_id
Client
Methods
- connect
- __init__
- api_key.setter
- config
- count_activities
- count_workflows
- create_schedule
- execute_activity
- execute_activity_class
- execute_activity_method
- execute_update_with_start_workflow
- execute_workflow
- get_activity_handle
- get_async_activity_handle
- get_schedule_handle
- get_worker_build_id_compatibility
- get_worker_task_reachability
- get_workflow_handle
- get_workflow_handle_for
- list_activities
- list_schedules
- list_workflows
- rpc_metadata.setter
- start_activity
- start_activity_class
- start_activity_method
- start_update_with_start_workflow
- start_workflow
- update_worker_build_id_compatibility
- _init_from_config
- _start_update_with_start
Attributes
- api_key
- data_converter
- identity
- namespace
- operator_service
- rpc_metadata
- service_client
- test_service
- workflow_service
- _config
- _impl
- _initial_config
ClientConfig
Attributes
- data_converter
- default_workflow_query_reject_condition
- header_codec_behavior
- interceptors
- namespace
- plugins
- service_client
ClientConnectConfig
Attributes
- api_key
- data_converter
- default_workflow_query_reject_condition
- dns_load_balancing_config
- header_codec_behavior
- http_connect_proxy_config
- identity
- interceptors
- keep_alive_config
- lazy
- namespace
- plugins
- retry_config
- rpc_metadata
- runtime
- target_host
- tls
CloudOperationsClient
Methods
- connect
- __init__
- api_key.setter
- rpc_metadata.setter
Attributes
- api_key
- cloud_service
- identity
- rpc_metadata
- service_client
- _service_client
CompleteAsyncActivityInput
Attributes
- data_converter_override
- id_or_token
- result
- rpc_metadata
- rpc_timeout
ConnectConfig
Methods
- __post_init__
- _to_bridge_config
Attributes
- api_key
- dns_load_balancing_config
- http_connect_proxy_config
- lazy
- retry_config
- rpc_metadata
- runtime
- target_host
- tls
- identity
CountActivitiesInput
Attributes
- query
- rpc_metadata
- rpc_timeout
CountWorkflowsInput
Attributes
- query
- rpc_metadata
- rpc_timeout
CreateScheduleInput
Attributes
- backfill
- id
- memo
- rpc_metadata
- rpc_timeout
- schedule
- search_attributes
- trigger_immediately
DeleteScheduleInput
Attributes
- id
- rpc_metadata
- rpc_timeout
DescribeActivityInput
Attributes
- activity_id
- activity_run_id
- long_poll_token
- rpc_metadata
- rpc_timeout
DescribeScheduleInput
Attributes
- id
- rpc_metadata
- rpc_timeout
DescribeWorkflowInput
Attributes
- id
- rpc_metadata
- rpc_timeout
- run_id
DnsLoadBalancingConfig
Methods
- _to_bridge_config
Attributes
- default
- resolution_interval_millis
FailAsyncActivityInput
Attributes
- data_converter_override
- error
- id_or_token
- last_heartbeat_details
- rpc_metadata
- rpc_timeout
FetchWorkflowHistoryEventsInput
Attributes
- event_filter_type
- id
- next_page_token
- page_size
- rpc_metadata
- rpc_timeout
- run_id
- skip_archival
- wait_new_event
GetWorkerBuildIdCompatibilityInput
Attributes
- max_sets
- rpc_metadata
- rpc_timeout
- task_queue
GetWorkerTaskReachabilityInput
Attributes
- build_ids
- reachability
- rpc_metadata
- rpc_timeout
- task_queues
HeaderCodecBehavior
Attributes
- CODEC
- NO_CODEC
- WORKFLOW_ONLY_CODEC
HeartbeatAsyncActivityInput
Attributes
- data_converter_override
- details
- id_or_token
- rpc_metadata
- rpc_timeout
HttpConnectProxyConfig
Methods
- _to_bridge_config
Attributes
- basic_auth
- target_host
Interceptor
Methods
- intercept_client
KeepAliveConfig
Methods
- _to_bridge_config
Attributes
- default
- interval_millis
- timeout_millis
ListActivitiesInput
Attributes
- limit
- next_page_token
- page_size
- query
- rpc_metadata
- rpc_timeout
ListSchedulesInput
Attributes
- next_page_token
- page_size
- query
- rpc_metadata
- rpc_timeout
ListWorkflowsInput
Attributes
- limit
- next_page_token
- page_size
- query
- rpc_metadata
- rpc_timeout
OutboundInterceptor
Methods
- __init__
- backfill_schedule
- cancel_activity
- cancel_workflow
- complete_async_activity
- count_activities
- count_workflows
- create_schedule
- delete_schedule
- describe_activity
- describe_schedule
- describe_workflow
- fail_async_activity
- fetch_workflow_history_events
- get_worker_build_id_compatibility
- get_worker_task_reachability
- heartbeat_async_activity
- list_activities
- list_schedules
- list_workflows
- pause_schedule
- query_workflow
- report_cancellation_async_activity
- signal_workflow
- start_activity
- start_update_with_start_workflow
- start_workflow
- start_workflow_update
- terminate_activity
- terminate_workflow
- trigger_schedule
- unpause_schedule
- update_schedule
- update_worker_build_id_compatibility
Attributes
- next
PauseScheduleInput
Attributes
- id
- note
- rpc_metadata
- rpc_timeout
PendingActivityState
Attributes
- CANCEL_REQUESTED
- PAUSE_REQUESTED
- PAUSED
- SCHEDULED
- STARTED
- UNSPECIFIED
Plugin
Methods
- configure_client
- connect_service_client
- name
QueryWorkflowInput
Attributes
- args
- headers
- id
- query
- reject_condition
- ret_type
- rpc_metadata
- rpc_timeout
- run_id
ReportCancellationAsyncActivityInput
Attributes
- data_converter_override
- details
- id_or_token
- rpc_metadata
- rpc_timeout
RetryConfig
Methods
- _to_bridge_config
Attributes
- initial_interval_millis
- max_elapsed_time_millis
- max_interval_millis
- max_retries
- multiplier
- randomization_factor
RPCStatusCode
Attributes
- ABORTED
- ALREADY_EXISTS
- CANCELLED
- DATA_LOSS
- DEADLINE_EXCEEDED
- FAILED_PRECONDITION
- INTERNAL
- INVALID_ARGUMENT
- NOT_FOUND
- OK
- OUT_OF_RANGE
- PERMISSION_DENIED
- RESOURCE_EXHAUSTED
- UNAUTHENTICATED
- UNAVAILABLE
- UNIMPLEMENTED
- UNKNOWN
Schedule
Methods
- _from_proto
- _to_proto
Attributes
- action
- policy
- spec
- state
ScheduleAction
Methods
- _from_proto
- _to_proto
ScheduleActionExecution
ScheduleActionExecutionStartWorkflow
Methods
- _from_proto
Attributes
- first_execution_run_id
- workflow_id
ScheduleActionResult
Methods
- _from_proto
Attributes
- action
- scheduled_at
- started_at
ScheduleActionStartWorkflow
Methods
- __init__
- _from_proto
- _to_proto
Attributes
- args
- execution_timeout
- headers
- id
- memo
- priority
- retry_policy
- run_timeout
- static_details
- static_summary
- task_queue
- task_timeout
- typed_search_attributes
- untyped_search_attributes
- workflow
- _from_raw
ScheduleAsyncIterator
Methods
- __aiter__
- __anext__
- __init__
- fetch_next_page
Attributes
- current_page
- current_page_index
- next_page_token
- _client
- _current_page
- _current_page_index
- _input
- _next_page_token
ScheduleBackfill
Methods
- _to_proto
Attributes
- end_at
- overlap
- start_at
ScheduleCalendarSpec
Methods
- _from_proto
- _to_proto
Attributes
- comment
- day_of_month
- day_of_week
- hour
- minute
- month
- second
- year
ScheduleDescription
Methods
- memo
- memo_value
- _from_proto
Attributes
- data_converter
- id
- info
- raw_description
- schedule
- search_attributes
- typed_search_attributes
ScheduleHandle
Methods
- __init__
- backfill
- delete
- describe
- pause
- trigger
- unpause
- update
Attributes
- id
- _client
ScheduleInfo
Methods
- _from_proto
Attributes
- created_at
- last_updated_at
- next_action_times
- num_actions
- num_actions_missed_catchup_window
- num_actions_skipped_overlap
- recent_actions
- running_actions
ScheduleIntervalSpec
Methods
- _from_proto
- _to_proto
Attributes
- every
- offset
ScheduleListAction
ScheduleListActionStartWorkflow
Attributes
- workflow
ScheduleListDescription
Methods
- memo
- memo_value
- _from_proto
Attributes
- data_converter
- id
- info
- raw_entry
- schedule
- search_attributes
- typed_search_attributes
ScheduleListInfo
Methods
- _from_proto
Attributes
- next_action_times
- recent_actions
ScheduleListSchedule
Methods
- _from_proto
Attributes
- action
- spec
- state
ScheduleListState
Methods
- _from_proto
Attributes
- note
- paused
ScheduleOverlapPolicy
Attributes
- ALLOW_ALL
- BUFFER_ALL
- BUFFER_ONE
- CANCEL_OTHER
- SKIP
- TERMINATE_OTHER
SchedulePolicy
Methods
- _from_proto
- _to_proto
Attributes
- catchup_window
- overlap
- pause_on_failure
ScheduleRange
Methods
- __post_init__
- _from_proto
- _from_protos
- _to_protos
- _to_proto
Attributes
- end
- start
- step
ScheduleSpec
Methods
- _from_proto
- _to_proto
Attributes
- calendars
- cron_expressions
- end_at
- intervals
- jitter
- skip
- start_at
- time_zone_name
ScheduleState
Methods
- _from_proto
- _to_proto
Attributes
- limited_actions
- note
- paused
- remaining_actions
ScheduleUpdate
Attributes
- schedule
- search_attributes
ScheduleUpdateInput
Attributes
- description
ServiceClient
Methods
- connect
- __init__
- check_health
- update_api_key
- update_rpc_metadata
- _rpc_call
Attributes
- cloud_service
- config
- health_service
- operator_service
- test_service
- workflow_service
- worker_service_client
SignalWorkflowInput
Attributes
- args
- headers
- id
- rpc_metadata
- rpc_timeout
- run_id
- signal
StartActivityInput
Attributes
- activity_type
- args
- headers
- heartbeat_timeout
- id
- id_conflict_policy
- id_reuse_policy
- priority
- result_type
- retry_policy
- rpc_metadata
- rpc_timeout
- schedule_to_close_timeout
- schedule_to_start_timeout
- search_attributes
- start_delay
- start_to_close_timeout
- summary
- task_queue
StartWorkflowInput
Attributes
- args
- callbacks
- cron_schedule
- execution_timeout
- headers
- id
- id_conflict_policy
- id_reuse_policy
- memo
- priority
- request_eager_start
- request_id
- ret_type
- retry_policy
- rpc_metadata
- rpc_timeout
- run_timeout
- search_attributes
- start_delay
- start_signal
- start_signal_args
- static_details
- static_summary
- task_queue
- task_timeout
- versioning_override
- workflow
- workflow_event_links
StartWorkflowUpdateInput
Attributes
- args
- first_execution_run_id
- headers
- id
- ret_type
- rpc_metadata
- rpc_timeout
- run_id
- update
- update_id
- wait_for_stage
StartWorkflowUpdateWithStartInput
Attributes
- start_workflow_input
- update_workflow_input
- _on_start
- _on_start_error
TaskReachabilityType
Methods
- _from_proto
- _to_proto
Attributes
- CLOSED_WORKFLOWS
- EXISTING_WORKFLOWS
- NEW_WORKFLOWS
- OPEN_WORKFLOWS
TerminateActivityInput
Attributes
- activity_id
- activity_run_id
- reason
- rpc_metadata
- rpc_timeout
TerminateWorkflowInput
Attributes
- args
- first_execution_run_id
- id
- reason
- rpc_metadata
- rpc_timeout
- run_id
TLSConfig
Methods
- _to_bridge_config
Attributes
- client_cert
- client_private_key
- domain
- server_root_ca_cert
TriggerScheduleInput
Attributes
- id
- overlap
- rpc_metadata
- rpc_timeout
UnpauseScheduleInput
Attributes
- id
- note
- rpc_metadata
- rpc_timeout
UpdateScheduleInput
Attributes
- id
- rpc_metadata
- rpc_timeout
- updater
UpdateWithStartStartWorkflowInput
Attributes
- args
- cron_schedule
- execution_timeout
- headers
- id
- id_conflict_policy
- id_reuse_policy
- memo
- priority
- ret_type
- retry_policy
- rpc_metadata
- rpc_timeout
- run_timeout
- search_attributes
- start_delay
- static_details
- static_summary
- task_queue
- task_timeout
- versioning_override
- workflow
UpdateWithStartUpdateWorkflowInput
Attributes
- args
- headers
- ret_type
- rpc_metadata
- rpc_timeout
- update
- update_id
- wait_for_stage
UpdateWorkerBuildIdCompatibilityInput
Attributes
- operation
- rpc_metadata
- rpc_timeout
- task_queue
WithStartWorkflowOperation
Methods
- __init__
- workflow_handle
Attributes
- _start_workflow_input
- _used
- _workflow_handle
WorkerBuildIdVersionSets
Methods
- default_build_id
- default_set
- _from_proto
Attributes
- version_sets
WorkerTaskReachability
Methods
- _from_proto
Attributes
- build_id_reachability
WorkflowExecution
Methods
- memo
- memo_value
- _from_raw_info
Attributes
- close_time
- execution_time
- history_length
- id
- namespace
- parent_id
- parent_run_id
- raw_info
- root_id
- root_run_id
- run_id
- search_attributes
- start_time
- status
- task_queue
- typed_search_attributes
- workflow_type
- data_converter
- _context_free_data_converter
WorkflowExecutionAsyncIterator
Methods
- __aiter__
- __anext__
- __init__
- fetch_next_page
- map_histories
Attributes
- current_page
- current_page_index
- next_page_token
- _client
- _current_page
- _current_page_index
- _input
- _limit
- _next_page_token
- _yielded
WorkflowExecutionCount
Methods
- _from_raw
Attributes
- count
- groups
WorkflowExecutionCountAggregationGroup
Methods
- _from_raw
Attributes
- count
- group_values
WorkflowExecutionDescription
Methods
- static_details
- static_summary
- _from_raw_description
- _decode_metadata
Inherited Methods
- memo
- memo_value
- _from_raw_info
Attributes
- raw_description
- _metadata_decoded
- _static_details
- _static_summary
Inherited Attributes
- close_time
- execution_time
- history_length
- id
- namespace
- parent_id
- parent_run_id
- raw_info
- root_id
- root_run_id
- run_id
- search_attributes
- start_time
- status
- task_queue
- typed_search_attributes
- workflow_type
- data_converter
- _context_free_data_converter
WorkflowExecutionStatus
Attributes
- CANCELED
- COMPLETED
- CONTINUED_AS_NEW
- FAILED
- RUNNING
- TERMINATED
- TIMED_OUT
WorkflowHandle
Methods
- __init__
- cancel
- describe
- execute_update
- fetch_history
- fetch_history_events
- get_update_handle
- get_update_handle_for
- query
- result
- signal
- start_update
- terminate
- _fetch_history_events_for_run
- _start_update
Attributes
- first_execution_run_id
- id
- result_run_id
- run_id
- __temporal_eagerly_started
- _client
- _first_execution_run_id
- _id
- _result_run_id
- _result_type
- _run_id
- _start_workflow_response
- _data_converter
WorkflowHistory
Methods
- from_json
- to_json
- to_json_dict
Attributes
- events
- workflow_id
- run_id
WorkflowHistoryEventAsyncIterator
Methods
- __aiter__
- __anext__
- __init__
- fetch_next_page
Attributes
- current_page
- current_page_index
- next_page_token
- _client
- _current_page
- _current_page_index
- _input
- _next_page_token
WorkflowHistoryEventFilterType
Attributes
- ALL_EVENT
- CLOSE_EVENT
WorkflowUpdateHandle
Methods
- __init__
- result
- _poll_until_outcome
Attributes
- id
- workflow_id
- workflow_run_id
- _client
- _id
- _known_outcome
- _result_type
- _workflow_id
- _workflow_run_id
- _data_converter
WorkflowUpdateStage
Attributes
- ACCEPTED
- ADMITTED
- COMPLETED
ActivityFailureError
Methods
- __init__
Attributes
- __cause__
- cause
AsyncActivityCancelledError
Methods
- __init__
Attributes
- details
Inherited Attributes
- cause
RPCError
Methods
- __init__
Attributes
- grpc_status
- message
- raw_grpc_status
- status
- _grpc_status
- _message
- _raw_grpc_status
- _status
Inherited Attributes
- cause
RPCTimeoutOrCancelledError
Inherited Attributes
- cause
ScheduleAlreadyRunningError
Methods
- __init__
Inherited Attributes
- cause
WorkflowContinuedAsNewError
Methods
- __init__
Attributes
- new_execution_run_id
- _new_execution_run_id
Inherited Attributes
- cause
WorkflowFailureError
Methods
- __init__
Attributes
- __cause__
- cause
WorkflowQueryFailedError
Methods
- __init__
Attributes
- message
- _message
Inherited Attributes
- cause
WorkflowQueryRejectedError
Methods
- __init__
Attributes
- status
- _status
Inherited Attributes
- cause
WorkflowUpdateFailedError
Methods
- __init__
Attributes
- __cause__
- cause
WorkflowUpdateRPCTimeoutOrCancelledError
Methods
- __init__
Inherited Attributes
- cause
_ClientImpl
Methods
Attributes
- _client
Inherited Attributes
- next

Functions

_apply_headers
_decode_user_metadata
_encode_user_metadata
_fix_history_enum
_fix_history_failure
_history_from_json

Variables

LocalReturnType
_pascal_case_match

`temporalio.client._client`

module documentation

(source)

Client support for accessing Temporal.

API Documentation for Temporal Python, generated by pydoctor 25.10.1 at 2026-05-18 21:02:18.