temporal_sdk_service (temporal_sdk v0.1.18)
View SourceTemporal general services module.
WIP. Module will provide following Temporal services:
reset_workflow_execution
terminate_workflow_execution
delete_workflow_execution
scan_workflow_executions
count_workflow_executions
describe_task_queue
get_cluster_info
get_system_info
list_task_queue_partitions
'UpdateWorkflowExecution'
'PollWorkflowExecutionUpdate'
'UpdateActivityOptions'
'UpdateWorkflowExecutionOptions'
'PauseActivity'
'UnpauseActivity'
'ResetActivity'
'ExecuteMultiOperation'
'CreateWorkflowRule'
'DescribeWorkflowRule'
'DeleteWorkflowRule'
'ListWorkflowRules'
'TriggerWorkflowRule'
Summary
Types
-type cancel_workflow_opts() :: [{namespace, unicode:chardata()} | {identity, unicode:chardata()} | {request_id, unicode:chardata()} | {first_execution_run_id, unicode:chardata()} | {reason, unicode:chardata()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest'()} | {response_type, temporal_sdk:response_type()}].
-type describe_workflow_opts() :: [{namespace, unicode:chardata()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.DescribeWorkflowExecutionRequest'()} | {response_type, temporal_sdk:response_type()}].
-type get_workflow_history_opts() :: [{namespace, unicode:chardata()} | {maximum_page_size, pos_integer()} | {next_page_token, binary()} | {wait_new_event, boolean()} | {history_event_filter_type, temporal_sdk_proto_service_workflow_binaries:'temporal.api.enums.v1.HistoryEventFilterType'()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryReverseRequest'()} | {response_type, temporal_sdk:response_type()} | {grpc_opts, temporal_sdk_client:grpc_opts()}].
-type get_workflow_history_reverse_opts() :: [{namespace, unicode:chardata()} | {maximum_page_size, pos_integer()} | {next_page_token, binary()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryReverseRequest'()} | {response_type, temporal_sdk:response_type()} | {grpc_opts, temporal_sdk_client:grpc_opts()}].
-type list_archived_workflows_opts() :: [{namespace, unicode:chardata()} | {page_size, pos_integer()} | {next_page_token, binary()} | {query, unicode:chardata()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListArchivedWorkflowExecutionsRequest'()} | {response_type, temporal_sdk:response_type()}].
-type list_closed_workflows_opts() :: [{namespace, unicode:chardata()} | {maximum_page_size, pos_integer()} | {next_page_token, binary()} | {start_time_filter, temporal_sdk_proto_service_workflow_binaries:'temporal.api.filter.v1.StartTimeFilter'()} | {filters, {execution_filter, temporal_sdk_proto_service_workflow_binaries:'temporal.api.filter.v1.WorkflowExecutionFilter'()} | {type_filter, temporal_sdk_proto_service_workflow_binaries:'temporal.api.filter.v1.WorkflowTypeFilter'()} | {status_filter, temporal_sdk_proto_service_workflow_binaries:'temporal.api.filter.v1.StatusFilter'()}} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListClosedWorkflowExecutionsRequest'()} | {response_type, temporal_sdk:response_type()}].
-type list_open_workflows_opts() :: [{namespace, unicode:chardata()} | {maximum_page_size, pos_integer()} | {next_page_token, binary()} | {start_time_filter, temporal_sdk_proto_service_workflow_binaries:'temporal.api.filter.v1.StartTimeFilter'()} | {filters, {execution_filter, temporal_sdk_proto_service_workflow_binaries:'temporal.api.filter.v1.WorkflowExecutionFilter'()} | {type_filter, temporal_sdk_proto_service_workflow_binaries:'temporal.api.filter.v1.WorkflowTypeFilter'()}} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListOpenWorkflowExecutionsRequest'()} | {response_type, temporal_sdk:response_type()}].
-type list_workflows_opts() :: [{namespace, unicode:chardata()} | {page_size, pos_integer()} | {next_page_token, binary()} | {query, unicode:chardata()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListWorkflowExecutionsRequest'()} | {response_type, temporal_sdk:response_type()}].
-type query_workflow_opts() :: [{namespace, unicode:chardata()} | {query_args, temporal_sdk:term_to_payloads()} | {header, temporal_sdk:term_to_mapstring_payload()} | {query_reject_condition, temporal_sdk_proto_service_workflow_binaries:'temporal.api.enums.v1.QueryRejectCondition'()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.QueryWorkflowRequest'()} | {response_type, temporal_sdk:response_type()}].
-type reset_workflow_opts() :: [{namespace, unicode:chardata()} | {reason, unicode:chardata()} | {workflow_task_finish_event_id, pos_integer()} | {request_id, unicode:chardata()} | {reset_reapply_exclude_types, temporal_sdk_proto_service_workflow_binaries:'temporal.api.enums.v1.ResetReapplyExcludeType'()} | {post_reset_operations, list()} | {identity, unicode:chardata()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ResetWorkflowExecutionRequest'()} | {response_type, temporal_sdk:response_type()}].
-type signal_workflow_opts() :: [{namespace, unicode:chardata()} | {input, temporal_sdk:term_to_payloads()} | {identity, unicode:chardata()} | {request_id, unicode:chardata()} | {header, temporal_sdk:term_to_mapstring_payload()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest'()} | {response_type, temporal_sdk:response_type()}].
-type update_workflow_opts() :: [{namespace, unicode:chardata()} | {first_execution_run_id, unicode:chardata()} | {wait_for_stage, temporal_sdk_proto_service_workflow_binaries:'temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage'()} | {update_id, unicode:chardata()} | {header, temporal_sdk:term_to_mapstring_payload()} | {args, temporal_sdk:term_to_payloads()} | {raw_request, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.QueryWorkflowRequest'()} | {response_type, temporal_sdk:response_type()}].
Functions
-spec cancel_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec cancel_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), Opts :: cancel_workflow_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec describe_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.DescribeWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec describe_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), Opts :: describe_workflow_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.DescribeWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec get_workflow_history(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse'()} | temporal_sdk:response().
-spec get_workflow_history(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), Opts :: get_workflow_history_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryResponse'()} | temporal_sdk:response().
-spec get_workflow_history_reverse(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryReverseResponse'()} | temporal_sdk:response().
-spec get_workflow_history_reverse(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), Opts :: get_workflow_history_reverse_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryReverseResponse'()} | temporal_sdk:response().
-spec list_archived_workflows(Cluster :: temporal_sdk_cluster:cluster_name()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListArchivedWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec list_archived_workflows(Cluster :: temporal_sdk_cluster:cluster_name(), Opts :: list_archived_workflows_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListArchivedWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec list_closed_workflows(Cluster :: temporal_sdk_cluster:cluster_name()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListClosedWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec list_closed_workflows(Cluster :: temporal_sdk_cluster:cluster_name(), Opts :: list_closed_workflows_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListClosedWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec list_open_workflows(Cluster :: temporal_sdk_cluster:cluster_name()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListOpenWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec list_open_workflows(Cluster :: temporal_sdk_cluster:cluster_name(), Opts :: list_open_workflows_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListOpenWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec list_workflows(Cluster :: temporal_sdk_cluster:cluster_name()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec list_workflows(Cluster :: temporal_sdk_cluster:cluster_name(), Opts :: list_workflows_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ListWorkflowExecutionsResponse'()} | temporal_sdk:response().
-spec query_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), QueryType :: unicode:chardata()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.QueryWorkflowResponse'()} | temporal_sdk:response().
-spec query_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), QueryType :: unicode:chardata(), Opts :: query_workflow_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.QueryWorkflowResponse'()} | temporal_sdk:response().
-spec reset_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ResetWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec reset_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), Opts :: reset_workflow_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.ResetWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec signal_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), SignalName :: unicode:chardata()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.SignalWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec signal_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), SignalName :: unicode:chardata(), Opts :: signal_workflow_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.SignalWorkflowExecutionResponse'()} | temporal_sdk:response().
-spec update_workflow(Cluster :: temporal_sdk_cluster:cluster_name(), WorkflowExecution :: temporal_sdk:workflow_execution(), Name :: unicode:chardata(), Opts :: update_workflow_opts()) -> {ok, temporal_sdk_proto_service_workflow_binaries:'temporal.api.workflowservice.v1.UpdateWorkflowExecutionResponse'()} | temporal_sdk:response().