Class: Temporalio::Workflow::Info

Inherits:
Struct
  • Object
show all
Defined in:
lib/temporalio/workflow/info.rb,
lib/temporalio/workflow/info.rb

Overview

Note:

WARNING: This class may have required parameters added to its constructor. Users should not instantiate this class or it may break in incompatible ways.

Information about the running workflow. This is immutable for the life of the workflow run.

Defined Under Namespace

Classes: ParentInfo, RootInfo

Instance Attribute Summary collapse

Instance Attribute Details

#attempt ⇒ Integer

Returns Current workflow attempt.

Returns:

  • (Integer) —

    Current workflow attempt.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def attempt
  @attempt
end

#continued_run_id ⇒ String?

Returns Run ID if this was continued.

Returns:

  • (String, nil) —

    Run ID if this was continued.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def continued_run_id
  @continued_run_id
end

#cron_schedule ⇒ String?

Returns Cron schedule if applicable.

Returns:

  • (String, nil) —

    Cron schedule if applicable.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def cron_schedule
  @cron_schedule
end

#execution_timeout ⇒ Float?

Returns Execution timeout for the workflow.

Returns:

  • (Float, nil) —

    Execution timeout for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def execution_timeout
  @execution_timeout
end

#first_execution_run_id ⇒ String

Returns The very first run ID the workflow ever had, following continuation chains.

Returns:

  • (String) —

    The very first run ID the workflow ever had, following continuation chains.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def first_execution_run_id
  @first_execution_run_id
end

#headers ⇒ Hash<String, Api::Common::V1::Payload>

Returns Headers.

Returns:



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def headers
  @headers
end

#last_failure ⇒ Exception?

Returns Failure if this workflow run is a continuation of a failure.

Returns:

  • (Exception, nil) —

    Failure if this workflow run is a continuation of a failure.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def last_failure
  @last_failure
end

#last_result ⇒ Object?

Returns Successful result if this workflow is a continuation of a success.

Returns:

  • (Object, nil) —

    Successful result if this workflow is a continuation of a success.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def last_result
  @last_result
end

#namespace ⇒ String

Returns Namespace for the workflow.

Returns:

  • (String) —

    Namespace for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def namespace
  @namespace
end

#parent ⇒ ParentInfo?

Returns Parent information for the workflow if this is a child.

Returns:

  • (ParentInfo, nil) —

    Parent information for the workflow if this is a child.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def parent
  @parent
end

#priority ⇒ Priority

Returns The priority of this workflow.

Returns:

  • (Priority) —

    The priority of this workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def priority
  @priority
end

#retry_policy ⇒ RetryPolicy?

Returns Retry policy for the workflow.

Returns:

  • (RetryPolicy, nil) —

    Retry policy for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def retry_policy
  @retry_policy
end

#root ⇒ RootInfo?

Returns Root information for the workflow. This is nil in pre-1.27.0 server versions or if there is no root (i.e. the root is itself).

Returns:

  • (RootInfo, nil) —

    Root information for the workflow. This is nil in pre-1.27.0 server versions or if there is no root (i.e. the root is itself).



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def root
  @root
end

#run_id ⇒ String

Returns Run ID for the workflow.

Returns:

  • (String) —

    Run ID for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def run_id
  @run_id
end

#run_timeout ⇒ Float?

Returns Run timeout for the workflow.

Returns:

  • (Float, nil) —

    Run timeout for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def run_timeout
  @run_timeout
end

#start_time ⇒ Time

Returns Time when the workflow started on the server.

Returns:

  • (Time) —

    Time when the workflow started on the server.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def start_time
  @start_time
end

#task_queue ⇒ String

Returns Task queue for the workflow.

Returns:

  • (String) —

    Task queue for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def task_queue
  @task_queue
end

#task_timeout ⇒ Float

Returns Task timeout for the workflow.

Returns:

  • (Float) —

    Task timeout for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def task_timeout
  @task_timeout
end

#workflow_id ⇒ String

Returns ID for the workflow.

Returns:

  • (String) —

    ID for the workflow.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def workflow_id
  @workflow_id
end

#workflow_type ⇒ String

Returns Workflow type name.

Returns:

  • (String) —

    Workflow type name.



75
76
77
 
# File 'lib/temporalio/workflow/info.rb', line 75

def workflow_type
  @workflow_type
end