temporalio 1.5.0 → 1.6.0

data/rbi/temporalio/api/sdk/v1/event_group_marker.rbi

@@ -0,0 +1,337 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: temporal/api/sdk/v1/event_group_marker.proto
+# typed: strict
+
+class Temporalio::Api::Sdk::V1::EventGroupMarker
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      label: T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::Label),
+      inbound_event: T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent),
+      inbound_update: T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate)
+    ).void
+  end
+  def initialize(
+    label: nil,
+    inbound_event: nil,
+    inbound_update: nil
+  )
+  end
+
+  sig { returns(T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::Label)) }
+  def label
+  end
+
+  sig { params(value: T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::Label)).void }
+  def label=(value)
+  end
+
+  sig { void }
+  def clear_label
+  end
+
+  sig { returns(T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent)) }
+  def inbound_event
+  end
+
+  sig { params(value: T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent)).void }
+  def inbound_event=(value)
+  end
+
+  sig { void }
+  def clear_inbound_event
+  end
+
+  sig { returns(T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate)) }
+  def inbound_update
+  end
+
+  sig { params(value: T.nilable(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate)).void }
+  def inbound_update=(value)
+  end
+
+  sig { void }
+  def clear_inbound_update
+  end
+
+  sig { returns(T.nilable(Symbol)) }
+  def variant
+  end
+
+  sig { params(field: String).returns(T.untyped) }
+  def [](field)
+  end
+
+  sig { params(field: String, value: T.untyped).void }
+  def []=(field, value)
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def to_h
+  end
+
+  sig { params(str: String).returns(Temporalio::Api::Sdk::V1::EventGroupMarker) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Temporalio::Api::Sdk::V1::EventGroupMarker) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+# A user-defined short-form string value to be used as the group's label.
+class Temporalio::Api::Sdk::V1::EventGroupMarker::Label
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      id: T.nilable(String),
+      label: T.nilable(Temporalio::Api::Common::V1::Payload)
+    ).void
+  end
+  def initialize(
+    id: "",
+    label: nil
+  )
+  end
+
+  # Opaque identifier assigned by the SDK.
+  sig { returns(String) }
+  def id
+  end
+
+  # Opaque identifier assigned by the SDK.
+  sig { params(value: String).void }
+  def id=(value)
+  end
+
+  # Opaque identifier assigned by the SDK.
+  sig { void }
+  def clear_id
+  end
+
+  # This payload should be a "json/plain"-encoded payload that is a single
+# JSON string for use in user interfaces. User interface formatting may not
+# apply to this text when used in "label" situations. The payload data
+# section is limited to 400 bytes by default.
+#
+# Payload only needs to be set on the first use of a given Marker ID;
+# further references to an existing Marker ID reuse existing attributes of
+# the referenced Marker -- i.e. further label payloads are ignored.
+#
+# Note that it is valid to have distinct Markers (i.e. distinct Marker IDs)
+# in a given workflow execution that carry the same label, provided that
+# they have the distinct ID.
+  sig { returns(T.nilable(Temporalio::Api::Common::V1::Payload)) }
+  def label
+  end
+
+  # This payload should be a "json/plain"-encoded payload that is a single
+# JSON string for use in user interfaces. User interface formatting may not
+# apply to this text when used in "label" situations. The payload data
+# section is limited to 400 bytes by default.
+#
+# Payload only needs to be set on the first use of a given Marker ID;
+# further references to an existing Marker ID reuse existing attributes of
+# the referenced Marker -- i.e. further label payloads are ignored.
+#
+# Note that it is valid to have distinct Markers (i.e. distinct Marker IDs)
+# in a given workflow execution that carry the same label, provided that
+# they have the distinct ID.
+  sig { params(value: T.nilable(Temporalio::Api::Common::V1::Payload)).void }
+  def label=(value)
+  end
+
+  # This payload should be a "json/plain"-encoded payload that is a single
+# JSON string for use in user interfaces. User interface formatting may not
+# apply to this text when used in "label" situations. The payload data
+# section is limited to 400 bytes by default.
+#
+# Payload only needs to be set on the first use of a given Marker ID;
+# further references to an existing Marker ID reuse existing attributes of
+# the referenced Marker -- i.e. further label payloads are ignored.
+#
+# Note that it is valid to have distinct Markers (i.e. distinct Marker IDs)
+# in a given workflow execution that carry the same label, provided that
+# they have the distinct ID.
+  sig { void }
+  def clear_label
+  end
+
+  sig { params(field: String).returns(T.untyped) }
+  def [](field)
+  end
+
+  sig { params(field: String, value: T.untyped).void }
+  def []=(field, value)
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def to_h
+  end
+
+  sig { params(str: String).returns(Temporalio::Api::Sdk::V1::EventGroupMarker::Label) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker::Label).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Temporalio::Api::Sdk::V1::EventGroupMarker::Label) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker::Label, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+# The event ID of an event in the present workflow that triggered implicit
+# creation of this group Marker.
+#
+# The target event's type must be one of the following:
+#  - `WORKFLOW_EXECUTION_STARTED`
+#  - `WORKFLOW_EXECUTION_SIGNALED`
+class Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      inbound_event_id: T.nilable(Integer)
+    ).void
+  end
+  def initialize(
+    inbound_event_id: 0
+  )
+  end
+
+  sig { returns(Integer) }
+  def inbound_event_id
+  end
+
+  sig { params(value: Integer).void }
+  def inbound_event_id=(value)
+  end
+
+  sig { void }
+  def clear_inbound_event_id
+  end
+
+  sig { params(field: String).returns(T.untyped) }
+  def [](field)
+  end
+
+  sig { params(field: String, value: T.untyped).void }
+  def []=(field, value)
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def to_h
+  end
+
+  sig { params(str: String).returns(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker::InboundEvent, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+# The identifier of an inbound Update (request.meta.update_id)
+# whose handler triggered implicit creation of this group Marker.
+#
+# Used in place of `inbound_event_id` for Updates because the event ID of the
+# UpdateAccepted history event is not known until the Workflow Task is
+# completed and recorded by the server, which may be too late.
+class Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      inbound_update_id: T.nilable(String)
+    ).void
+  end
+  def initialize(
+    inbound_update_id: ""
+  )
+  end
+
+  sig { returns(String) }
+  def inbound_update_id
+  end
+
+  sig { params(value: String).void }
+  def inbound_update_id=(value)
+  end
+
+  sig { void }
+  def clear_inbound_update_id
+  end
+
+  sig { params(field: String).returns(T.untyped) }
+  def [](field)
+  end
+
+  sig { params(field: String, value: T.untyped).void }
+  def []=(field, value)
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def to_h
+  end
+
+  sig { params(str: String).returns(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::EventGroupMarker::InboundUpdate, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end

data/rbi/temporalio/api/sdk/v1/external_storage.rbi

@@ -0,0 +1,85 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: temporal/api/sdk/v1/external_storage.proto
+# typed: strict
+
+# ExternalStorageReference identifies a payload stored in an external storage system.
+# It is used as a claim-check token, allowing the actual payload data to be retrieved
+# from the named driver using the provided claim data.
+class Temporalio::Api::Sdk::V1::ExternalStorageReference
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      driver_name: T.nilable(String),
+      claim_data: T.nilable(T::Hash[String, String])
+    ).void
+  end
+  def initialize(
+    driver_name: "",
+    claim_data: ::Google::Protobuf::Map.new(:string, :string)
+  )
+  end
+
+  # The name of the storage driver responsible for retrieving the payload.
+  sig { returns(String) }
+  def driver_name
+  end
+
+  # The name of the storage driver responsible for retrieving the payload.
+  sig { params(value: String).void }
+  def driver_name=(value)
+  end
+
+  # The name of the storage driver responsible for retrieving the payload.
+  sig { void }
+  def clear_driver_name
+  end
+
+  # Driver-specific key-value pairs that identify and provide access to the stored payload.
+  sig { returns(T::Hash[String, String]) }
+  def claim_data
+  end
+
+  # Driver-specific key-value pairs that identify and provide access to the stored payload.
+  sig { params(value: ::Google::Protobuf::Map).void }
+  def claim_data=(value)
+  end
+
+  # Driver-specific key-value pairs that identify and provide access to the stored payload.
+  sig { void }
+  def clear_claim_data
+  end
+
+  sig { params(field: String).returns(T.untyped) }
+  def [](field)
+  end
+
+  sig { params(field: String, value: T.untyped).void }
+  def []=(field, value)
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def to_h
+  end
+
+  sig { params(str: String).returns(Temporalio::Api::Sdk::V1::ExternalStorageReference) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::ExternalStorageReference).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Temporalio::Api::Sdk::V1::ExternalStorageReference) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::ExternalStorageReference, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end

data/rbi/temporalio/api/sdk/v1/task_complete_metadata.rbi

@@ -0,0 +1,206 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: temporal/api/sdk/v1/task_complete_metadata.proto
+# typed: strict
+
+class Temporalio::Api::Sdk::V1::WorkflowTaskCompletedMetadata
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      core_used_flags: T.nilable(T::Array[Integer]),
+      lang_used_flags: T.nilable(T::Array[Integer]),
+      sdk_name: T.nilable(String),
+      sdk_version: T.nilable(String)
+    ).void
+  end
+  def initialize(
+    core_used_flags: [],
+    lang_used_flags: [],
+    sdk_name: "",
+    sdk_version: ""
+  )
+  end
+
+  # Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:
+#
+# During replay:
+# * If a flag is not recognized (value is too high or not defined), it must fail the workflow
+#   task.
+# * If a flag is recognized, it is stored in a set of used flags for the run. Code checks for
+#   that flag during and after this WFT are allowed to assume that the flag is present.
+# * If a code check for a flag does not find the flag in the set of used flags, it must take
+#   the branch corresponding to the absence of that flag.
+#
+# During non-replay execution of new WFTs:
+# * The SDK is free to use all flags it knows about. It must record any newly-used (IE: not
+#   previously recorded) flags when completing the WFT.
+#
+# SDKs which are too old to even know about this field at all are considered to produce
+# undefined behavior if they replay workflows which used this mechanism.
+#
+# (-- api-linter: core::0141::forbidden-types=disabled
+#     aip.dev/not-precedent: These really shouldn't have negative values. --)
+  sig { returns(T::Array[Integer]) }
+  def core_used_flags
+  end
+
+  # Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:
+#
+# During replay:
+# * If a flag is not recognized (value is too high or not defined), it must fail the workflow
+#   task.
+# * If a flag is recognized, it is stored in a set of used flags for the run. Code checks for
+#   that flag during and after this WFT are allowed to assume that the flag is present.
+# * If a code check for a flag does not find the flag in the set of used flags, it must take
+#   the branch corresponding to the absence of that flag.
+#
+# During non-replay execution of new WFTs:
+# * The SDK is free to use all flags it knows about. It must record any newly-used (IE: not
+#   previously recorded) flags when completing the WFT.
+#
+# SDKs which are too old to even know about this field at all are considered to produce
+# undefined behavior if they replay workflows which used this mechanism.
+#
+# (-- api-linter: core::0141::forbidden-types=disabled
+#     aip.dev/not-precedent: These really shouldn't have negative values. --)
+  sig { params(value: ::Google::Protobuf::RepeatedField).void }
+  def core_used_flags=(value)
+  end
+
+  # Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:
+#
+# During replay:
+# * If a flag is not recognized (value is too high or not defined), it must fail the workflow
+#   task.
+# * If a flag is recognized, it is stored in a set of used flags for the run. Code checks for
+#   that flag during and after this WFT are allowed to assume that the flag is present.
+# * If a code check for a flag does not find the flag in the set of used flags, it must take
+#   the branch corresponding to the absence of that flag.
+#
+# During non-replay execution of new WFTs:
+# * The SDK is free to use all flags it knows about. It must record any newly-used (IE: not
+#   previously recorded) flags when completing the WFT.
+#
+# SDKs which are too old to even know about this field at all are considered to produce
+# undefined behavior if they replay workflows which used this mechanism.
+#
+# (-- api-linter: core::0141::forbidden-types=disabled
+#     aip.dev/not-precedent: These really shouldn't have negative values. --)
+  sig { void }
+  def clear_core_used_flags
+  end
+
+  # Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages
+# here as processing a workflow with a different language than the one which authored it is
+# already undefined behavior. See `core_used_patches` for more.
+#
+# (-- api-linter: core::0141::forbidden-types=disabled
+#     aip.dev/not-precedent: These really shouldn't have negative values. --)
+  sig { returns(T::Array[Integer]) }
+  def lang_used_flags
+  end
+
+  # Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages
+# here as processing a workflow with a different language than the one which authored it is
+# already undefined behavior. See `core_used_patches` for more.
+#
+# (-- api-linter: core::0141::forbidden-types=disabled
+#     aip.dev/not-precedent: These really shouldn't have negative values. --)
+  sig { params(value: ::Google::Protobuf::RepeatedField).void }
+  def lang_used_flags=(value)
+  end
+
+  # Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages
+# here as processing a workflow with a different language than the one which authored it is
+# already undefined behavior. See `core_used_patches` for more.
+#
+# (-- api-linter: core::0141::forbidden-types=disabled
+#     aip.dev/not-precedent: These really shouldn't have negative values. --)
+  sig { void }
+  def clear_lang_used_flags
+  end
+
+  # Name of the SDK that processed the task. This is usually something like "temporal-go" and is
+# usually the same as client-name gRPC header. This should only be set if its value changed
+# since the last time recorded on the workflow (or be set on the first task).
+#
+# (-- api-linter: core::0122::name-suffix=disabled
+#     aip.dev/not-precedent: We're ok with a name suffix here. --)
+  sig { returns(String) }
+  def sdk_name
+  end
+
+  # Name of the SDK that processed the task. This is usually something like "temporal-go" and is
+# usually the same as client-name gRPC header. This should only be set if its value changed
+# since the last time recorded on the workflow (or be set on the first task).
+#
+# (-- api-linter: core::0122::name-suffix=disabled
+#     aip.dev/not-precedent: We're ok with a name suffix here. --)
+  sig { params(value: String).void }
+  def sdk_name=(value)
+  end
+
+  # Name of the SDK that processed the task. This is usually something like "temporal-go" and is
+# usually the same as client-name gRPC header. This should only be set if its value changed
+# since the last time recorded on the workflow (or be set on the first task).
+#
+# (-- api-linter: core::0122::name-suffix=disabled
+#     aip.dev/not-precedent: We're ok with a name suffix here. --)
+  sig { void }
+  def clear_sdk_name
+  end
+
+  # Version of the SDK that processed the task. This is usually something like "1.20.0" and is
+# usually the same as client-version gRPC header. This should only be set if its value changed
+# since the last time recorded on the workflow (or be set on the first task).
+  sig { returns(String) }
+  def sdk_version
+  end
+
+  # Version of the SDK that processed the task. This is usually something like "1.20.0" and is
+# usually the same as client-version gRPC header. This should only be set if its value changed
+# since the last time recorded on the workflow (or be set on the first task).
+  sig { params(value: String).void }
+  def sdk_version=(value)
+  end
+
+  # Version of the SDK that processed the task. This is usually something like "1.20.0" and is
+# usually the same as client-version gRPC header. This should only be set if its value changed
+# since the last time recorded on the workflow (or be set on the first task).
+  sig { void }
+  def clear_sdk_version
+  end
+
+  sig { params(field: String).returns(T.untyped) }
+  def [](field)
+  end
+
+  sig { params(field: String, value: T.untyped).void }
+  def []=(field, value)
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def to_h
+  end
+
+  sig { params(str: String).returns(Temporalio::Api::Sdk::V1::WorkflowTaskCompletedMetadata) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::WorkflowTaskCompletedMetadata).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Temporalio::Api::Sdk::V1::WorkflowTaskCompletedMetadata) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Temporalio::Api::Sdk::V1::WorkflowTaskCompletedMetadata, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end