Class: Temporalio::Activity::Info

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/activity/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 an activity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#activity_id ⇒ String

Returns ID for the activity.

Returns:

  • (String) —

    ID for the activity.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#activity_type ⇒ String

Returns Type name for the activity.

Returns:

  • (String) —

    Type name for the activity.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#attempt ⇒ Integer

Returns Attempt the activity is on.

Returns:

  • (Integer) —

    Attempt the activity is on.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#current_attempt_scheduled_time ⇒ Time

Returns When the current attempt was scheduled.

Returns:

  • (Time) —

    When the current attempt was scheduled.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#heartbeat_timeout ⇒ Float?

Returns Heartbeat timeout set by the caller.

Returns:

  • (Float, nil) —

    Heartbeat timeout set by the caller.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#local? ⇒ Boolean

Returns Whether the activity is a local activity or not.

Returns:

  • (Boolean) —

    Whether the activity is a local activity or not.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#priority ⇒ Priority

Returns The priority of this activity.

Returns:

  • (Priority) —

    The priority of this activity.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#raw_heartbeat_details ⇒ Array<Converter::RawValue>

Returns Raw details from the last heartbeat of the last attempt. Can use #heartbeat_details to get lazily-converted values.

Returns:

  • (Array<Converter::RawValue>) —

    Raw details from the last heartbeat of the last attempt. Can use #heartbeat_details to get lazily-converted values.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#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.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#scheduled_time ⇒ Time

Returns When the activity was scheduled.

Returns:

  • (Time) —

    When the activity was scheduled.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#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.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#started_time ⇒ Time

Returns When the activity started.

Returns:

  • (Time) —

    When the activity started.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#task_queue ⇒ String

Returns Task queue this activity is on.

Returns:

  • (String) —

    Task queue this activity is on.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#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.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#workflow_id ⇒ String

Returns Workflow ID that started this activity.

Returns:

  • (String) —

    Workflow ID that started this activity.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#workflow_namespace ⇒ String

Returns Namespace this activity is on.

Returns:

  • (String) —

    Namespace this activity is on.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#workflow_run_id ⇒ String

Returns Workflow run ID that started this activity.

Returns:

  • (String) —

    Workflow run ID that started this activity.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

#workflow_type ⇒ String

Returns Workflow type name that started this activity.

Returns:

  • (String) —

    Workflow type name that started this activity.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/temporalio/activity/info.rb', line 72

class Info
  # Convert raw heartbeat details into Ruby types.
  #
  # Note, this live-converts every invocation.
  #
  # @param hints [Array<Object>, nil] Hints, if any, to assist conversion.
  # @return [Array<Object>] Converted details.
  def heartbeat_details(hints: nil)
    Internal::ProtoUtils.convert_from_payload_array(
      Context.current.payload_converter,
      raw_heartbeat_details.map(&:payload),
      hints:
    )
  end
end

Instance Method Details

#heartbeat_details(hints: nil) ⇒ Array<Object>

Convert raw heartbeat details into Ruby types.

Note, this live-converts every invocation.

Parameters:

  • hints (Array<Object>, nil) (defaults to: nil) —

    Hints, if any, to assist conversion.

Returns:

  • (Array<Object>) —

    Converted details.



79
80
81
82
83
84
85
 
# File 'lib/temporalio/activity/info.rb', line 79

def heartbeat_details(hints: nil)
  Internal::ProtoUtils.convert_from_payload_array(
    Context.current.payload_converter,
    raw_heartbeat_details.map(&:payload),
    hints:
  )
end