Class: Temporalio::Activity::Info

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

Overview

Class containing information about an activity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#activity_id ⇒ String

Returns Activity ID.

Returns:

  • (String) —

    Activity ID.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def activity_id
  @activity_id
end

#activity_type ⇒ String

Returns Name of the activity.

Returns:

  • (String) —

    Name of the activity.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def activity_type
  @activity_type
end

#attempt ⇒ Integer

Returns Activity’s execution attempt.

Returns:

  • (Integer) —

    Activity’s execution attempt.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def attempt
  @attempt
end

#current_attempt_scheduled_time ⇒ Time

Returns Scheduled time of the current attempt.

Returns:

  • (Time) —

    Scheduled time of the current attempt.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def current_attempt_scheduled_time
  @current_attempt_scheduled_time
end

#heartbeat_details ⇒ Array<any>

Returns Details submitted with the last heartbeat.

Returns:

  • (Array<any>) —

    Details submitted with the last heartbeat.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def heartbeat_details
  @heartbeat_details
end

#heartbeat_timeout ⇒ Float

Returns Max time between heartbeats (in seconds).

Returns:

  • (Float) —

    Max time between heartbeats (in seconds).



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def heartbeat_timeout
  @heartbeat_timeout
end

#local ⇒ Boolean

Returns Whether activity is local or not.

Returns:

  • (Boolean) —

    Whether activity is local or not.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def local
  @local
end

#schedule_to_close_timeout ⇒ Float

Returns Max overall activity execution time (in seconds).

Returns:

  • (Float) —

    Max overall activity execution time (in seconds).



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def schedule_to_close_timeout
  @schedule_to_close_timeout
end

#scheduled_time ⇒ Time

Returns Time when activity was first scheduled.

Returns:

  • (Time) —

    Time when activity was first scheduled.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def scheduled_time
  @scheduled_time
end

#start_to_close_timeout ⇒ Float

Returns Max time of a single invocation (in seconds).

Returns:

  • (Float) —

    Max time of a single invocation (in seconds).



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def start_to_close_timeout
  @start_to_close_timeout
end

#started_time ⇒ Time

Returns Time when activity was started.

Returns:

  • (Time) —

    Time when activity was started.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def started_time
  @started_time
end

#task_queue ⇒ String

Returns Task queue on which the activity got scheduled.

Returns:

  • (String) —

    Task queue on which the activity got scheduled.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def task_queue
  @task_queue
end

#task_token ⇒ String

Returns A token for completing the activity.

Returns:

  • (String) —

    A token for completing the activity.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def task_token
  @task_token
end

#workflow_id ⇒ String

Returns Workflow ID.

Returns:

  • (String) —

    Workflow ID.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def workflow_id
  @workflow_id
end

#workflow_namespace ⇒ String

Returns Workflow namespace.

Returns:

  • (String) —

    Workflow namespace.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def workflow_namespace
  @workflow_namespace
end

#workflow_run_id ⇒ String

Returns Workflow run ID.

Returns:

  • (String) —

    Workflow run ID.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def workflow_run_id
  @workflow_run_id
end

#workflow_type ⇒ String

Returns Name of the workflow.

Returns:

  • (String) —

    Name of the workflow.



4
5
6
 
# File 'lib/temporalio/activity/info.rb', line 4

def workflow_type
  @workflow_type
end

Instance Method Details

#local? ⇒ Boolean

Whether activity is local or not

Returns:

  • (Boolean) —

    True for local activities, falst otherwise.



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

def local?
  local
end