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

Instance Attribute Summary collapse

Instance Attribute Details

#attempt ⇒ Integer

Returns Current workflow attempt.

Returns:

  • (Integer) —

    Current workflow attempt.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def attempt
  @attempt
end

#continued_run_id ⇒ String?

Returns Run ID if this was continued.

Returns:

  • (String, nil) —

    Run ID if this was continued.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def continued_run_id
  @continued_run_id
end

#cron_schedule ⇒ String?

Returns Cron schedule if applicable.

Returns:

  • (String, nil) —

    Cron schedule if applicable.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def cron_schedule
  @cron_schedule
end

#execution_timeout ⇒ Float?

Returns Execution timeout for the workflow.

Returns:

  • (Float, nil) —

    Execution timeout for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def execution_timeout
  @execution_timeout
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.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

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.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def last_result
  @last_result
end

#namespace ⇒ String

Returns Namespace for the workflow.

Returns:

  • (String) —

    Namespace for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

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.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def parent
  @parent
end

#retry_policy ⇒ RetryPolicy?

Returns Retry policy for the workflow.

Returns:

  • (RetryPolicy, nil) —

    Retry policy for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def retry_policy
  @retry_policy
end

#run_id ⇒ String

Returns Run ID for the workflow.

Returns:

  • (String) —

    Run ID for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def run_id
  @run_id
end

#run_timeout ⇒ Float?

Returns Run timeout for the workflow.

Returns:

  • (Float, nil) —

    Run timeout for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def run_timeout
  @run_timeout
end

#start_time ⇒ Time

Returns Time when the workflow started.

Returns:

  • (Time) —

    Time when the workflow started.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def start_time
  @start_time
end

#task_queue ⇒ String

Returns Task queue for the workflow.

Returns:

  • (String) —

    Task queue for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def task_queue
  @task_queue
end

#task_timeout ⇒ Float

Returns Task timeout for the workflow.

Returns:

  • (Float) —

    Task timeout for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def task_timeout
  @task_timeout
end

#workflow_id ⇒ String

Returns ID for the workflow.

Returns:

  • (String) —

    ID for the workflow.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def workflow_id
  @workflow_id
end

#workflow_type ⇒ String

Returns Workflow type name.

Returns:

  • (String) —

    Workflow type name.



62
63
64
 
# File 'lib/temporalio/workflow/info.rb', line 62

def workflow_type
  @workflow_type
end