temporalio 0.0.2 → 0.1.1

data/sig/protos/temporal/api/workflowservice/v1/service.rbs

@@ -0,0 +1,22 @@
+module Temporalio
+  module Api
+    module WorkflowService
+      module V1
+        # WorkflowService API defines how Temporal SDKs and other clients interact with the Temporal server
+        #  to create and interact with workflows and activities.
+        #
+        #  Users are expected to call `StartWorkflowExecution` to create a new workflow execution.
+        #
+        #  To drive workflows, a worker using a Temporal SDK must exist which regularly polls for workflow
+        #  and activity tasks from the service. For each workflow task, the sdk must process the
+        #  (incremental or complete) event history and respond back with any newly generated commands.
+        #
+        #  For each activity task, the worker is expected to execute the user's code which implements that
+        #  activity, responding with completion or failure.
+        #
+        class WorkflowService < ::Protobuf::Rpc::Service
+        end
+      end
+    end
+  end
+end

data/sig/protos/temporal/sdk/core/activity_result/activity_result.rbs

@@ -0,0 +1,380 @@
+module Temporalio
+  module Bridge
+    module Api
+      module ActivityResult
+        # *
+        #  Used to report activity completions to core
+        #
+        class ActivityExecutionResult < ::Protobuf::Message
+          # Encode the message to a binary string
+          #
+          def self.encode: (ActivityExecutionResult) -> String
+
+          attr_accessor completed(): ::Temporalio::Bridge::Api::ActivityResult::Success?
+
+          def completed=: [M < ::Temporalio::Bridge::Api::ActivityResult::Success::_ToProto] (M?) -> M?
+                        | ...
+
+          def completed!: () -> ::Temporalio::Bridge::Api::ActivityResult::Success?
+
+          attr_accessor failed(): ::Temporalio::Bridge::Api::ActivityResult::Failure?
+
+          def failed=: [M < ::Temporalio::Bridge::Api::ActivityResult::Failure::_ToProto] (M?) -> M?
+                     | ...
+
+          def failed!: () -> ::Temporalio::Bridge::Api::ActivityResult::Failure?
+
+          attr_accessor cancelled(): ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+
+          def cancelled=: [M < ::Temporalio::Bridge::Api::ActivityResult::Cancellation::_ToProto] (M?) -> M?
+                        | ...
+
+          def cancelled!: () -> ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+
+          attr_accessor will_complete_async(): ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync?
+
+          def will_complete_async=: [M < ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync::_ToProto] (M?) -> M?
+                                  | ...
+
+          def will_complete_async!: () -> ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync?
+
+          def initialize: (?completed: ::Temporalio::Bridge::Api::ActivityResult::Success::init?, ?failed: ::Temporalio::Bridge::Api::ActivityResult::Failure::init?, ?cancelled: ::Temporalio::Bridge::Api::ActivityResult::Cancellation::init?, ?will_complete_async: ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync::init?) -> void
+
+          def []: (:completed) -> ::Temporalio::Bridge::Api::ActivityResult::Success?
+                | (:failed) -> ::Temporalio::Bridge::Api::ActivityResult::Failure?
+                | (:cancelled) -> ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+                | (:will_complete_async) -> ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync?
+                | (::Symbol) -> untyped
+
+          def []=: (:completed, ::Temporalio::Bridge::Api::ActivityResult::Success?) -> ::Temporalio::Bridge::Api::ActivityResult::Success?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::Success::_ToProto] (:completed, M?) -> M?
+                 | (:failed, ::Temporalio::Bridge::Api::ActivityResult::Failure?) -> ::Temporalio::Bridge::Api::ActivityResult::Failure?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::Failure::_ToProto] (:failed, M?) -> M?
+                 | (:cancelled, ::Temporalio::Bridge::Api::ActivityResult::Cancellation?) -> ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::Cancellation::_ToProto] (:cancelled, M?) -> M?
+                 | (:will_complete_async, ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync?) -> ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::WillCompleteAsync::_ToProto] (:will_complete_async, M?) -> M?
+                 | (::Symbol, untyped) -> untyped
+
+          interface _ToProto
+            def to_proto: () -> ActivityExecutionResult
+          end
+
+          # The type of `#initialize` parameter.
+          type init = ActivityExecutionResult | _ToProto
+
+          # The type of `repeated` field.
+          type field_array = ::Protobuf::Field::FieldArray[ActivityExecutionResult, ActivityExecutionResult | _ToProto]
+
+          # The type of `map` field.
+          type field_hash[KEY] = ::Protobuf::Field::FieldHash[KEY, ActivityExecutionResult, ActivityExecutionResult | _ToProto]
+
+          type array = ::Array[ActivityExecutionResult | _ToProto]
+
+          type hash[KEY] = ::Hash[KEY, ActivityExecutionResult | _ToProto]
+        end
+
+        # Used to report activity resolutions to lang. IE: This is what the activities are resolved with
+        #  in the workflow.
+        #
+        class ActivityResolution < ::Protobuf::Message
+          # Encode the message to a binary string
+          #
+          def self.encode: (ActivityResolution) -> String
+
+          attr_accessor completed(): ::Temporalio::Bridge::Api::ActivityResult::Success?
+
+          def completed=: [M < ::Temporalio::Bridge::Api::ActivityResult::Success::_ToProto] (M?) -> M?
+                        | ...
+
+          def completed!: () -> ::Temporalio::Bridge::Api::ActivityResult::Success?
+
+          attr_accessor failed(): ::Temporalio::Bridge::Api::ActivityResult::Failure?
+
+          def failed=: [M < ::Temporalio::Bridge::Api::ActivityResult::Failure::_ToProto] (M?) -> M?
+                     | ...
+
+          def failed!: () -> ::Temporalio::Bridge::Api::ActivityResult::Failure?
+
+          attr_accessor cancelled(): ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+
+          def cancelled=: [M < ::Temporalio::Bridge::Api::ActivityResult::Cancellation::_ToProto] (M?) -> M?
+                        | ...
+
+          def cancelled!: () -> ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+
+          attr_accessor backoff(): ::Temporalio::Bridge::Api::ActivityResult::DoBackoff?
+
+          def backoff=: [M < ::Temporalio::Bridge::Api::ActivityResult::DoBackoff::_ToProto] (M?) -> M?
+                      | ...
+
+          def backoff!: () -> ::Temporalio::Bridge::Api::ActivityResult::DoBackoff?
+
+          def initialize: (?completed: ::Temporalio::Bridge::Api::ActivityResult::Success::init?, ?failed: ::Temporalio::Bridge::Api::ActivityResult::Failure::init?, ?cancelled: ::Temporalio::Bridge::Api::ActivityResult::Cancellation::init?, ?backoff: ::Temporalio::Bridge::Api::ActivityResult::DoBackoff::init?) -> void
+
+          def []: (:completed) -> ::Temporalio::Bridge::Api::ActivityResult::Success?
+                | (:failed) -> ::Temporalio::Bridge::Api::ActivityResult::Failure?
+                | (:cancelled) -> ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+                | (:backoff) -> ::Temporalio::Bridge::Api::ActivityResult::DoBackoff?
+                | (::Symbol) -> untyped
+
+          def []=: (:completed, ::Temporalio::Bridge::Api::ActivityResult::Success?) -> ::Temporalio::Bridge::Api::ActivityResult::Success?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::Success::_ToProto] (:completed, M?) -> M?
+                 | (:failed, ::Temporalio::Bridge::Api::ActivityResult::Failure?) -> ::Temporalio::Bridge::Api::ActivityResult::Failure?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::Failure::_ToProto] (:failed, M?) -> M?
+                 | (:cancelled, ::Temporalio::Bridge::Api::ActivityResult::Cancellation?) -> ::Temporalio::Bridge::Api::ActivityResult::Cancellation?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::Cancellation::_ToProto] (:cancelled, M?) -> M?
+                 | (:backoff, ::Temporalio::Bridge::Api::ActivityResult::DoBackoff?) -> ::Temporalio::Bridge::Api::ActivityResult::DoBackoff?
+                 | [M < ::Temporalio::Bridge::Api::ActivityResult::DoBackoff::_ToProto] (:backoff, M?) -> M?
+                 | (::Symbol, untyped) -> untyped
+
+          interface _ToProto
+            def to_proto: () -> ActivityResolution
+          end
+
+          # The type of `#initialize` parameter.
+          type init = ActivityResolution | _ToProto
+
+          # The type of `repeated` field.
+          type field_array = ::Protobuf::Field::FieldArray[ActivityResolution, ActivityResolution | _ToProto]
+
+          # The type of `map` field.
+          type field_hash[KEY] = ::Protobuf::Field::FieldHash[KEY, ActivityResolution, ActivityResolution | _ToProto]
+
+          type array = ::Array[ActivityResolution | _ToProto]
+
+          type hash[KEY] = ::Hash[KEY, ActivityResolution | _ToProto]
+        end
+
+        # * Used to report successful completion either when executing or resolving
+        #
+        class Success < ::Protobuf::Message
+          # Encode the message to a binary string
+          #
+          def self.encode: (Success) -> String
+
+          attr_accessor result(): ::Temporalio::Api::Common::V1::Payload?
+
+          def result=: [M < ::Temporalio::Api::Common::V1::Payload::_ToProto] (M?) -> M?
+                     | ...
+
+          def result!: () -> ::Temporalio::Api::Common::V1::Payload?
+
+          def initialize: (?result: ::Temporalio::Api::Common::V1::Payload::init?) -> void
+
+          def []: (:result) -> ::Temporalio::Api::Common::V1::Payload?
+                | (::Symbol) -> untyped
+
+          def []=: (:result, ::Temporalio::Api::Common::V1::Payload?) -> ::Temporalio::Api::Common::V1::Payload?
+                 | [M < ::Temporalio::Api::Common::V1::Payload::_ToProto] (:result, M?) -> M?
+                 | (::Symbol, untyped) -> untyped
+
+          interface _ToProto
+            def to_proto: () -> Success
+          end
+
+          # The type of `#initialize` parameter.
+          type init = Success | _ToProto
+
+          # The type of `repeated` field.
+          type field_array = ::Protobuf::Field::FieldArray[Success, Success | _ToProto]
+
+          # The type of `map` field.
+          type field_hash[KEY] = ::Protobuf::Field::FieldHash[KEY, Success, Success | _ToProto]
+
+          type array = ::Array[Success | _ToProto]
+
+          type hash[KEY] = ::Hash[KEY, Success | _ToProto]
+        end
+
+        # * Used to report activity failure either when executing or resolving
+        #
+        class Failure < ::Protobuf::Message
+          # Encode the message to a binary string
+          #
+          def self.encode: (Failure) -> String
+
+          attr_accessor failure(): ::Temporalio::Api::Failure::V1::Failure?
+
+          def failure=: [M < ::Temporalio::Api::Failure::V1::Failure::_ToProto] (M?) -> M?
+                      | ...
+
+          def failure!: () -> ::Temporalio::Api::Failure::V1::Failure?
+
+          def initialize: (?failure: ::Temporalio::Api::Failure::V1::Failure::init?) -> void
+
+          def []: (:failure) -> ::Temporalio::Api::Failure::V1::Failure?
+                | (::Symbol) -> untyped
+
+          def []=: (:failure, ::Temporalio::Api::Failure::V1::Failure?) -> ::Temporalio::Api::Failure::V1::Failure?
+                 | [M < ::Temporalio::Api::Failure::V1::Failure::_ToProto] (:failure, M?) -> M?
+                 | (::Symbol, untyped) -> untyped
+
+          interface _ToProto
+            def to_proto: () -> Failure
+          end
+
+          # The type of `#initialize` parameter.
+          type init = Failure | _ToProto
+
+          # The type of `repeated` field.
+          type field_array = ::Protobuf::Field::FieldArray[Failure, Failure | _ToProto]
+
+          # The type of `map` field.
+          type field_hash[KEY] = ::Protobuf::Field::FieldHash[KEY, Failure, Failure | _ToProto]
+
+          type array = ::Array[Failure | _ToProto]
+
+          type hash[KEY] = ::Hash[KEY, Failure | _ToProto]
+        end
+
+        # *
+        #  Used to report cancellation from both Core and Lang.
+        #  When Lang reports a cancelled activity, it must put a CancelledFailure in the failure field.
+        #  When Core reports a cancelled activity, it must put an ActivityFailure with CancelledFailure
+        #  as the cause in the failure field.
+        #
+        class Cancellation < ::Protobuf::Message
+          # Encode the message to a binary string
+          #
+          def self.encode: (Cancellation) -> String
+
+          attr_accessor failure(): ::Temporalio::Api::Failure::V1::Failure?
+
+          def failure=: [M < ::Temporalio::Api::Failure::V1::Failure::_ToProto] (M?) -> M?
+                      | ...
+
+          def failure!: () -> ::Temporalio::Api::Failure::V1::Failure?
+
+          def initialize: (?failure: ::Temporalio::Api::Failure::V1::Failure::init?) -> void
+
+          def []: (:failure) -> ::Temporalio::Api::Failure::V1::Failure?
+                | (::Symbol) -> untyped
+
+          def []=: (:failure, ::Temporalio::Api::Failure::V1::Failure?) -> ::Temporalio::Api::Failure::V1::Failure?
+                 | [M < ::Temporalio::Api::Failure::V1::Failure::_ToProto] (:failure, M?) -> M?
+                 | (::Symbol, untyped) -> untyped
+
+          interface _ToProto
+            def to_proto: () -> Cancellation
+          end
+
+          # The type of `#initialize` parameter.
+          type init = Cancellation | _ToProto
+
+          # The type of `repeated` field.
+          type field_array = ::Protobuf::Field::FieldArray[Cancellation, Cancellation | _ToProto]
+
+          # The type of `map` field.
+          type field_hash[KEY] = ::Protobuf::Field::FieldHash[KEY, Cancellation, Cancellation | _ToProto]
+
+          type array = ::Array[Cancellation | _ToProto]
+
+          type hash[KEY] = ::Hash[KEY, Cancellation | _ToProto]
+        end
+
+        # *
+        #  Used in ActivityExecutionResult to notify Core that this Activity will complete asynchronously.
+        #  Core will forget about this Activity and free up resources used to track this Activity.
+        #
+        class WillCompleteAsync < ::Protobuf::Message
+          # Encode the message to a binary string
+          #
+          def self.encode: (WillCompleteAsync) -> String
+
+          def initialize: () -> void
+
+          interface _ToProto
+            def to_proto: () -> WillCompleteAsync
+          end
+
+          # The type of `#initialize` parameter.
+          type init = WillCompleteAsync | _ToProto
+
+          # The type of `repeated` field.
+          type field_array = ::Protobuf::Field::FieldArray[WillCompleteAsync, WillCompleteAsync | _ToProto]
+
+          # The type of `map` field.
+          type field_hash[KEY] = ::Protobuf::Field::FieldHash[KEY, WillCompleteAsync, WillCompleteAsync | _ToProto]
+
+          type array = ::Array[WillCompleteAsync | _ToProto]
+
+          type hash[KEY] = ::Hash[KEY, WillCompleteAsync | _ToProto]
+        end
+
+        # *
+        #  Issued when a local activity needs to retry but also wants to back off more than would be
+        #  reasonable to WFT heartbeat for. Lang is expected to schedule a timer for the duration
+        #  and then start a local activity of the same type & same inputs with the provided attempt number
+        #  after the timer has elapsed.
+        #
+        #  This exists because Core does not have a concept of starting commands by itself, they originate
+        #  from lang. So expecting lang to start the timer / next pass of the activity fits more smoothly.
+        #
+        class DoBackoff < ::Protobuf::Message
+          # Encode the message to a binary string
+          #
+          def self.encode: (DoBackoff) -> String
+
+          # The attempt number that lang should provide when scheduling the retry. If the LA failed
+          #  on attempt 4 and we told lang to back off with a timer, this number will be 5.
+          #
+          attr_accessor attempt(): ::Integer
+
+          def attempt!: () -> ::Integer?
+
+          attr_accessor backoff_duration(): ::Google::Protobuf::Duration?
+
+          def backoff_duration=: [M < ::Google::Protobuf::Duration::_ToProto] (M?) -> M?
+                               | ...
+
+          def backoff_duration!: () -> ::Google::Protobuf::Duration?
+
+          # The time the first attempt of this local activity was scheduled. Must be passed with attempt
+          #  to the retry LA.
+          #
+          attr_accessor original_schedule_time(): ::Google::Protobuf::Timestamp?
+
+          # The time the first attempt of this local activity was scheduled. Must be passed with attempt
+          #  to the retry LA.
+          #
+          def original_schedule_time=: [M < ::Google::Protobuf::Timestamp::_ToProto] (M?) -> M?
+                                     | ...
+
+          def original_schedule_time!: () -> ::Google::Protobuf::Timestamp?
+
+          def initialize: (?attempt: ::Integer, ?backoff_duration: ::Google::Protobuf::Duration::init?, ?original_schedule_time: ::Google::Protobuf::Timestamp::init?) -> void
+
+          def []: (:attempt) -> ::Integer
+                | (:backoff_duration) -> ::Google::Protobuf::Duration?
+                | (:original_schedule_time) -> ::Google::Protobuf::Timestamp?
+                | (::Symbol) -> untyped
+
+          def []=: (:attempt, ::Integer) -> ::Integer
+                 | (:backoff_duration, ::Google::Protobuf::Duration?) -> ::Google::Protobuf::Duration?
+                 | [M < ::Google::Protobuf::Duration::_ToProto] (:backoff_duration, M?) -> M?
+                 | (:original_schedule_time, ::Google::Protobuf::Timestamp?) -> ::Google::Protobuf::Timestamp?
+                 | [M < ::Google::Protobuf::Timestamp::_ToProto] (:original_schedule_time, M?) -> M?
+                 | (::Symbol, untyped) -> untyped
+
+          interface _ToProto
+            def to_proto: () -> DoBackoff
+          end
+
+          # The type of `#initialize` parameter.
+          type init = DoBackoff | _ToProto
+
+          # The type of `repeated` field.
+          type field_array = ::Protobuf::Field::FieldArray[DoBackoff, DoBackoff | _ToProto]
+
+          # The type of `map` field.
+          type field_hash[KEY] = ::Protobuf::Field::FieldHash[KEY, DoBackoff, DoBackoff | _ToProto]
+
+          type array = ::Array[DoBackoff | _ToProto]
+
+          type hash[KEY] = ::Hash[KEY, DoBackoff | _ToProto]
+        end
+      end
+    end
+  end
+end