TemporalSdk.Workflow (temporal_sdk v0.1.18)

Temporal workflow task module.

WIP Temporal commands:

start_activity WIP: session_execution, direct_execution, direct_result

TODO Temporal commands:

start_nexus/4
start_nexus/5
cancel_nexus
upsert_workflow_search_attributes
cancel_external_workflow
signal_external_workflow

Summary

Functions

admit_signal(signal_or_signal_name)

See :temporal_sdk_workflow.admit_signal/1.

admit_signal(signal_or_signal_name, opts)

See :temporal_sdk_workflow.admit_signal/2.

await(await_pattern)

See :temporal_sdk_workflow.await/1.

await(await_pattern, timeout)

See :temporal_sdk_workflow.await/2.

await_all(await_pattern)

See :temporal_sdk_workflow.await_all/1.

await_all(await_pattern, timeout)

See :temporal_sdk_workflow.await_all/2.

await_info(info_or_info_id)

See :temporal_sdk_workflow.await_info/1.

await_info(info_or_info_id, info_timeout, awaitable_timeout)

See :temporal_sdk_workflow.await_info/3.

await_one(await_pattern)

See :temporal_sdk_workflow.await_one/1.

await_one(await_pattern, timeout)

See :temporal_sdk_workflow.await_one/2.

await_open_before_close(is_enabled)

See :temporal_sdk_workflow.await_open_before_close/1.

cancel_activity(activity_or_activity_data)

See :temporal_sdk_workflow.cancel_activity/1.

cancel_activity(activity_or_activity_data, opts)

See :temporal_sdk_workflow.cancel_activity/2.

cancel_timer(timer_or_timer_data_or_timer_id)

See :temporal_sdk_workflow.cancel_timer/1.

cancel_timer(timer_or_timer_data_or_timer_id, opts)

See :temporal_sdk_workflow.cancel_timer/2.

cancel_workflow_execution(details)

See :temporal_sdk_workflow.cancel_workflow_execution/1.

complete_workflow_execution(result)

See :temporal_sdk_workflow.complete_workflow_execution/1.

continue_as_new_workflow(task_queue, workflow_type)

See :temporal_sdk_workflow.continue_as_new_workflow/2.

continue_as_new_workflow(task_queue, workflow_type, opts)

See :temporal_sdk_workflow.continue_as_new_workflow/3.

evict_workflow()

Requests workflow eviction on next workflow task completion request.

fail_workflow_execution(application_failure)

See :temporal_sdk_workflow.fail_workflow_execution/1.

get_workflow_result()

See :temporal_sdk_workflow.get_workflow_result/0.

is_awaited(await_pattern)

See :temporal_sdk_workflow.is_awaited/1.

is_awaited_all(await_pattern)

See :temporal_sdk_workflow.is_awaited_all/1.

is_awaited_one(await_pattern)

See :temporal_sdk_workflow.is_awaited_one/1.

modify_workflow_properties(upserted_memo_fields)

See :temporal_sdk_workflow.modify_workflow_properties/1.

modify_workflow_properties(upserted_memo_fields, opts)

See :temporal_sdk_workflow.modify_workflow_properties/2.

record_app_env(par)

See :temporal_sdk_workflow.record_app_env/1.

record_app_env(par, opts)

See :temporal_sdk_workflow.record_app_env/2.

record_marker(marker_value_fun)

See :temporal_sdk_workflow.record_marker/1.

record_marker(marker_value_fun, opts)

See :temporal_sdk_workflow.record_marker/2.

record_os_env(var_name)

See :temporal_sdk_workflow.record_os_env/1.

record_os_env(var_name, opts)

See :temporal_sdk_workflow.record_os_env/2.

record_rand_uniform()

See :temporal_sdk_workflow.record_rand_uniform/0.

record_rand_uniform(range_or_opts)

See :temporal_sdk_workflow.record_rand_uniform/1.

record_rand_uniform(range, opts)

See :temporal_sdk_workflow.record_rand_uniform/2.

record_system_time()

See :temporal_sdk_workflow.record_system_time/0.

record_system_time(unit_or_opts)

See :temporal_sdk_workflow.record_system_time/1.

record_system_time(unit, opts)

See :temporal_sdk_workflow.record_system_time/2.

record_uuid4()

See :temporal_sdk_workflow.record_uuid4/0.

record_uuid4(opts)

See :temporal_sdk_workflow.record_uuid4/1.

respond_query(query_type, opts)

See :temporal_sdk_workflow.respond_query/2.

select_history(event_id_or_pattern_or_spec_or_continuation)

See :temporal_sdk_workflow.select_history/1.

select_history(history_pattern_spec, limit)

See :temporal_sdk_workflow.select_history/2.

select_index(pattern_or_spec_or_continuation)

See :temporal_sdk_workflow.select_index/1.

select_index(index_pattern_spec, limit)

See :temporal_sdk_workflow.select_index/2.

set_info(info_value)

See :temporal_sdk_workflow.set_info/1.

set_info(info_value, opts)

See :temporal_sdk_workflow.set_info/2.

set_workflow_result(workflow_result)

See :temporal_sdk_workflow.set_workflow_result/1.

start_activity(activity_type, input)

See :temporal_sdk_workflow.start_activity/2.

start_activity(activity_type, input, opts)

See :temporal_sdk_workflow.start_activity/3.

start_child_workflow(task_queue, workflow_type)

See :temporal_sdk_workflow.start_child_workflow/2.

start_child_workflow(task_queue, workflow_type, opts)

See :temporal_sdk_workflow.start_child_workflow/3.

start_execution(function)

See :temporal_sdk_workflow.start_execution/1.

start_execution(function, input)

See :temporal_sdk_workflow.start_execution/2.

start_execution(function, input, opts)

See :temporal_sdk_workflow.start_execution/3.

start_execution(module, function, input, opts)

See :temporal_sdk_workflow.start_execution/4.

start_nexus(endpoint, service, operation, input)

See :temporal_sdk_workflow.start_nexus/4.

start_nexus(endpoint, service, operation, input, opts)

See :temporal_sdk_workflow.start_nexus/5.

start_timer(start_to_fire_timeout)

See :temporal_sdk_workflow.start_timer/1.

start_timer(start_to_fire_timeout, opts)

See :temporal_sdk_workflow.start_timer/2.

terminate_executor()

See :temporal_sdk_workflow.terminate_executor/0.

terminate_executor(reason)

See :temporal_sdk_workflow.terminate_executor/1.

wait(await_pattern)

See :temporal_sdk_workflow.wait/1.

wait(await_pattern, timeout)

See :temporal_sdk_workflow.wait/2.

wait_all(await_pattern)

See :temporal_sdk_workflow.wait_all/1.

wait_all(await_pattern, timeout)

See :temporal_sdk_workflow.wait_all/2.

wait_info(info_or_info_id)

See :temporal_sdk_workflow.wait_info/1.

wait_info(info_or_info_id, info_timeout, awaitable_timeout)

See :temporal_sdk_workflow.wait_info/3.

wait_one(await_pattern)

See :temporal_sdk_workflow.wait_one/1.

wait_one(await_pattern, timeout)

See :temporal_sdk_workflow.wait_one/2.

workflow_info()

See :temporal_sdk_workflow.workflow_info/0.

Functions

admit_signal(signal_or_signal_name)

See :temporal_sdk_workflow.admit_signal/1.

admit_signal(signal_or_signal_name, opts)

See :temporal_sdk_workflow.admit_signal/2.

await(await_pattern)

See :temporal_sdk_workflow.await/1.

await(await_pattern, timeout)

See :temporal_sdk_workflow.await/2.

await_all(await_pattern)

See :temporal_sdk_workflow.await_all/1.

await_all(await_pattern, timeout)

See :temporal_sdk_workflow.await_all/2.

await_info(info_or_info_id)

See :temporal_sdk_workflow.await_info/1.

await_info(info_or_info_id, info_timeout, awaitable_timeout)

See :temporal_sdk_workflow.await_info/3.

await_one(await_pattern)

See :temporal_sdk_workflow.await_one/1.

await_one(await_pattern, timeout)

See :temporal_sdk_workflow.await_one/2.

await_open_before_close(is_enabled)

See :temporal_sdk_workflow.await_open_before_close/1.

cancel_activity(activity_or_activity_data)

See :temporal_sdk_workflow.cancel_activity/1.

cancel_activity(activity_or_activity_data, opts)

See :temporal_sdk_workflow.cancel_activity/2.

cancel_timer(timer_or_timer_data_or_timer_id)

See :temporal_sdk_workflow.cancel_timer/1.

cancel_timer(timer_or_timer_data_or_timer_id, opts)

See :temporal_sdk_workflow.cancel_timer/2.

cancel_workflow_execution(details)

See :temporal_sdk_workflow.cancel_workflow_execution/1.

complete_workflow_execution(result)

See :temporal_sdk_workflow.complete_workflow_execution/1.

continue_as_new_workflow(task_queue, workflow_type)

See :temporal_sdk_workflow.continue_as_new_workflow/2.

continue_as_new_workflow(task_queue, workflow_type, opts)

See :temporal_sdk_workflow.continue_as_new_workflow/3.

evict_workflow()

Requests workflow eviction on next workflow task completion request.

SDK Architecture - Workflow Eviction section provides details about workflow eviction mechanism.

Duplicate eviction requests within the same workflow task cycle are ignored. Eviction requests are ignored during workflow replay.

SDK Samples Eviction Parallel Handler sample demonstrates function usage.

fail_workflow_execution(application_failure)

See :temporal_sdk_workflow.fail_workflow_execution/1.

get_workflow_result()

See :temporal_sdk_workflow.get_workflow_result/0.

is_awaited(await_pattern)

See :temporal_sdk_workflow.is_awaited/1.

is_awaited_all(await_pattern)

See :temporal_sdk_workflow.is_awaited_all/1.

is_awaited_one(await_pattern)

See :temporal_sdk_workflow.is_awaited_one/1.

modify_workflow_properties(upserted_memo_fields)

See :temporal_sdk_workflow.modify_workflow_properties/1.

modify_workflow_properties(upserted_memo_fields, opts)

See :temporal_sdk_workflow.modify_workflow_properties/2.

record_app_env(par)

See :temporal_sdk_workflow.record_app_env/1.

record_app_env(par, opts)

See :temporal_sdk_workflow.record_app_env/2.

record_marker(marker_value_fun)

See :temporal_sdk_workflow.record_marker/1.

record_marker(marker_value_fun, opts)

See :temporal_sdk_workflow.record_marker/2.

record_os_env(var_name)

See :temporal_sdk_workflow.record_os_env/1.

record_os_env(var_name, opts)

See :temporal_sdk_workflow.record_os_env/2.

record_rand_uniform()

See :temporal_sdk_workflow.record_rand_uniform/0.

record_rand_uniform(range_or_opts)

See :temporal_sdk_workflow.record_rand_uniform/1.

record_rand_uniform(range, opts)

See :temporal_sdk_workflow.record_rand_uniform/2.

record_system_time()

See :temporal_sdk_workflow.record_system_time/0.

record_system_time(unit_or_opts)

See :temporal_sdk_workflow.record_system_time/1.

record_system_time(unit, opts)

See :temporal_sdk_workflow.record_system_time/2.

record_uuid4()

See :temporal_sdk_workflow.record_uuid4/0.

record_uuid4(opts)

See :temporal_sdk_workflow.record_uuid4/1.

respond_query(query_type, opts)

See :temporal_sdk_workflow.respond_query/2.

select_history(event_id_or_pattern_or_spec_or_continuation)

See :temporal_sdk_workflow.select_history/1.

select_history(history_pattern_spec, limit)

See :temporal_sdk_workflow.select_history/2.

select_index(pattern_or_spec_or_continuation)

See :temporal_sdk_workflow.select_index/1.

select_index(index_pattern_spec, limit)

See :temporal_sdk_workflow.select_index/2.

set_info(info_value)

See :temporal_sdk_workflow.set_info/1.

set_info(info_value, opts)

See :temporal_sdk_workflow.set_info/2.

set_workflow_result(workflow_result)

See :temporal_sdk_workflow.set_workflow_result/1.

start_activity(activity_type, input)

See :temporal_sdk_workflow.start_activity/2.

start_activity(activity_type, input, opts)

See :temporal_sdk_workflow.start_activity/3.

start_child_workflow(task_queue, workflow_type)

See :temporal_sdk_workflow.start_child_workflow/2.

start_child_workflow(task_queue, workflow_type, opts)

See :temporal_sdk_workflow.start_child_workflow/3.

start_execution(function)

See :temporal_sdk_workflow.start_execution/1.

start_execution(function, input)

See :temporal_sdk_workflow.start_execution/2.

start_execution(function, input, opts)

See :temporal_sdk_workflow.start_execution/3.

start_execution(module, function, input, opts)

See :temporal_sdk_workflow.start_execution/4.

start_nexus(endpoint, service, operation, input)

See :temporal_sdk_workflow.start_nexus/4.

start_nexus(endpoint, service, operation, input, opts)

See :temporal_sdk_workflow.start_nexus/5.

start_timer(start_to_fire_timeout)

See :temporal_sdk_workflow.start_timer/1.

start_timer(start_to_fire_timeout, opts)

See :temporal_sdk_workflow.start_timer/2.

terminate_executor()

See :temporal_sdk_workflow.terminate_executor/0.

terminate_executor(reason)

See :temporal_sdk_workflow.terminate_executor/1.

wait(await_pattern)

See :temporal_sdk_workflow.wait/1.

wait(await_pattern, timeout)

See :temporal_sdk_workflow.wait/2.

wait_all(await_pattern)

See :temporal_sdk_workflow.wait_all/1.

wait_all(await_pattern, timeout)

See :temporal_sdk_workflow.wait_all/2.

wait_info(info_or_info_id)

See :temporal_sdk_workflow.wait_info/1.

wait_info(info_or_info_id, info_timeout, awaitable_timeout)

See :temporal_sdk_workflow.wait_info/3.

wait_one(await_pattern)

See :temporal_sdk_workflow.wait_one/1.

wait_one(await_pattern, timeout)

See :temporal_sdk_workflow.wait_one/2.

workflow_info()

See :temporal_sdk_workflow.workflow_info/0.