Class: Temporalio::Activity::Info

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

Overview

Information about an activity.

Instance Attribute Summary collapse

Instance Attribute Details

#activity_id ⇒ String

Returns ID for the activity.

Returns:

  • (String) —

    ID for the activity.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#activity_type ⇒ String

Returns Type name for the activity.

Returns:

  • (String) —

    Type name for the activity.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#attempt ⇒ Integer

Returns Attempt the activity is on.

Returns:

  • (Integer) —

    Attempt the activity is on.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#current_attempt_scheduled_time ⇒ Time

Returns When the current attempt was scheduled.

Returns:

  • (Time) —

    When the current attempt was scheduled.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#heartbeat_details ⇒ Array<Object>

Returns Details from the last heartbeat of the last attempt.

Returns:

  • (Array<Object>) —

    Details from the last heartbeat of the last attempt.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#heartbeat_timeout ⇒ Float?

Returns Heartbeat timeout set by the caller.

Returns:

  • (Float, nil) —

    Heartbeat timeout set by the caller.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#local? ⇒ Boolean

Returns Whether the activity is a local activity or not.

Returns:

  • (Boolean) —

    Whether the activity is a local activity or not.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#schedule_to_close_timeout ⇒ Float?

Returns Schedule to close timeout set by the caller.

Returns:

  • (Float, nil) —

    Schedule to close timeout set by the caller.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#scheduled_time ⇒ Time

Returns When the activity was scheduled.

Returns:

  • (Time) —

    When the activity was scheduled.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#start_to_close_timeout ⇒ Float?

Returns Start to close timeout set by the caller.

Returns:

  • (Float, nil) —

    Start to close timeout set by the caller.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#started_time ⇒ Time

Returns When the activity started.

Returns:

  • (Time) —

    When the activity started.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#task_queue ⇒ String

Returns Task queue this activity is on.

Returns:

  • (String) —

    Task queue this activity is on.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#task_token ⇒ String

Returns Task token uniquely identifying this activity. Note, this is a ‘ASCII-8BIT` encoded string, not a `UTF-8` encoded string nor a valid UTF-8 string.

Returns:

  • (String) —

    Task token uniquely identifying this activity. Note, this is a ‘ASCII-8BIT` encoded string, not a `UTF-8` encoded string nor a valid UTF-8 string.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#workflow_id ⇒ String

Returns Workflow ID that started this activity.

Returns:

  • (String) —

    Workflow ID that started this activity.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#workflow_namespace ⇒ String

Returns Namespace this activity is on.

Returns:

  • (String) —

    Namespace this activity is on.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#workflow_run_id ⇒ String

Returns Workflow run ID that started this activity.

Returns:

  • (String) —

    Workflow run ID that started this activity.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)

#workflow_type ⇒ String

Returns Workflow type name that started this activity.

Returns:

  • (String) —

    Workflow type name that started this activity.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/temporalio/activity/info.rb', line 42

Info = Struct.new(
  :activity_id,
  :activity_type,
  :attempt,
  :current_attempt_scheduled_time,
  :heartbeat_details,
  :heartbeat_timeout,
  :local?,
  :schedule_to_close_timeout,
  :scheduled_time,
  :start_to_close_timeout,
  :started_time,
  :task_queue,
  :task_token,
  :workflow_id,
  :workflow_namespace,
  :workflow_run_id,
  :workflow_type,
  keyword_init: true
)