statelydb 0.21.0 → 0.23.0

data/rbi/db/list_pb.rbi

@@ -0,0 +1,472 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: db/list.proto
+# typed: strict
+
+class Stately::Db::BeginListRequest
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      store_id: T.nilable(Integer),
+      key_path_prefix: T.nilable(String),
+      limit: T.nilable(Integer),
+      allow_stale: T.nilable(T::Boolean),
+      sort_property: T.nilable(T.any(Symbol, String, Integer)),
+      sort_direction: T.nilable(T.any(Symbol, String, Integer)),
+      schema_version_id: T.nilable(Integer),
+      schema_id: T.nilable(Integer)
+    ).void
+  end
+  def initialize(
+    store_id: 0,
+    key_path_prefix: "",
+    limit: 0,
+    allow_stale: false,
+    sort_property: :SORTABLE_PROPERTY_KEY_PATH,
+    sort_direction: :SORT_ASCENDING,
+    schema_version_id: 0,
+    schema_id: 0
+  )
+  end
+
+  # store_id is a globally unique Store ID, which can be looked up from the
+# console or CLI.
+  sig { returns(Integer) }
+  def store_id
+  end
+
+  # store_id is a globally unique Store ID, which can be looked up from the
+# console or CLI.
+  sig { params(value: Integer).void }
+  def store_id=(value)
+  end
+
+  # store_id is a globally unique Store ID, which can be looked up from the
+# console or CLI.
+  sig { void }
+  def clear_store_id
+  end
+
+  # key_path_prefix is the a prefix that limits what items we will return. This
+# must contain at least a root segment. See Item#key_path for more details.
+  sig { returns(String) }
+  def key_path_prefix
+  end
+
+  # key_path_prefix is the a prefix that limits what items we will return. This
+# must contain at least a root segment. See Item#key_path for more details.
+  sig { params(value: String).void }
+  def key_path_prefix=(value)
+  end
+
+  # key_path_prefix is the a prefix that limits what items we will return. This
+# must contain at least a root segment. See Item#key_path for more details.
+  sig { void }
+  def clear_key_path_prefix
+  end
+
+  # limit is the maximum number of items to return. If this is not specified or
+# set to 0, it will default to unlimited. Fewer items than the limit may be
+# returned even if there are more items to get - make sure to check
+# token.can_continue.
+  sig { returns(Integer) }
+  def limit
+  end
+
+  # limit is the maximum number of items to return. If this is not specified or
+# set to 0, it will default to unlimited. Fewer items than the limit may be
+# returned even if there are more items to get - make sure to check
+# token.can_continue.
+  sig { params(value: Integer).void }
+  def limit=(value)
+  end
+
+  # limit is the maximum number of items to return. If this is not specified or
+# set to 0, it will default to unlimited. Fewer items than the limit may be
+# returned even if there are more items to get - make sure to check
+# token.can_continue.
+  sig { void }
+  def clear_limit
+  end
+
+  # allow_stale indicates that you're okay with getting slightly stale items -
+# that is, if you had just changed an item and then call a List operation,
+# you might get the old version of the item. This can result in improved
+# performance, availability, and cost.
+  sig { returns(T::Boolean) }
+  def allow_stale
+  end
+
+  # allow_stale indicates that you're okay with getting slightly stale items -
+# that is, if you had just changed an item and then call a List operation,
+# you might get the old version of the item. This can result in improved
+# performance, availability, and cost.
+  sig { params(value: T::Boolean).void }
+  def allow_stale=(value)
+  end
+
+  # allow_stale indicates that you're okay with getting slightly stale items -
+# that is, if you had just changed an item and then call a List operation,
+# you might get the old version of the item. This can result in improved
+# performance, availability, and cost.
+  sig { void }
+  def clear_allow_stale
+  end
+
+  # sort_property is the property of the item to sort the results by. If this
+# is not set, we will sort by key path.
+  sig { returns(T.any(Symbol, Integer)) }
+  def sort_property
+  end
+
+  # sort_property is the property of the item to sort the results by. If this
+# is not set, we will sort by key path.
+  sig { params(value: T.any(Symbol, String, Integer)).void }
+  def sort_property=(value)
+  end
+
+  # sort_property is the property of the item to sort the results by. If this
+# is not set, we will sort by key path.
+  sig { void }
+  def clear_sort_property
+  end
+
+  # sort_direction is the direction to sort the results in. If this is not set,
+# we will sort in ascending order.
+  sig { returns(T.any(Symbol, Integer)) }
+  def sort_direction
+  end
+
+  # sort_direction is the direction to sort the results in. If this is not set,
+# we will sort in ascending order.
+  sig { params(value: T.any(Symbol, String, Integer)).void }
+  def sort_direction=(value)
+  end
+
+  # sort_direction is the direction to sort the results in. If this is not set,
+# we will sort in ascending order.
+  sig { void }
+  def clear_sort_direction
+  end
+
+  # schema_version_id refers to the item version to return.
+#
+# If the store's schema does not have this version, the operation
+# will error with SchemaVersionNotFound error. You should not have to
+# set this manually as your generated SDK should know its schema version
+# and wire this in for you.
+  sig { returns(Integer) }
+  def schema_version_id
+  end
+
+  # schema_version_id refers to the item version to return.
+#
+# If the store's schema does not have this version, the operation
+# will error with SchemaVersionNotFound error. You should not have to
+# set this manually as your generated SDK should know its schema version
+# and wire this in for you.
+  sig { params(value: Integer).void }
+  def schema_version_id=(value)
+  end
+
+  # schema_version_id refers to the item version to return.
+#
+# If the store's schema does not have this version, the operation
+# will error with SchemaVersionNotFound error. You should not have to
+# set this manually as your generated SDK should know its schema version
+# and wire this in for you.
+  sig { void }
+  def clear_schema_version_id
+  end
+
+  # schema_id refers to the schema to use for this operation.
+# If the store_id does not have a schema with this ID, the operation will
+# error with SchemaNotFound error. You should not have to set this manually
+# as your generated SDK should know its schema and wire this in for you.
+  sig { returns(Integer) }
+  def schema_id
+  end
+
+  # schema_id refers to the schema to use for this operation.
+# If the store_id does not have a schema with this ID, the operation will
+# error with SchemaNotFound error. You should not have to set this manually
+# as your generated SDK should know its schema and wire this in for you.
+  sig { params(value: Integer).void }
+  def schema_id=(value)
+  end
+
+  # schema_id refers to the schema to use for this operation.
+# If the store_id does not have a schema with this ID, the operation will
+# error with SchemaNotFound error. You should not have to set this manually
+# as your generated SDK should know its schema and wire this in for you.
+  sig { void }
+  def clear_schema_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(Stately::Db::BeginListRequest) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::BeginListRequest).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::BeginListRequest) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::BeginListRequest, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+# These are stream messages, so multiple responses may be sent.
+class Stately::Db::ListResponse
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      result: T.nilable(Stately::Db::ListPartialResult),
+      finished: T.nilable(Stately::Db::ListFinished)
+    ).void
+  end
+  def initialize(
+    result: nil,
+    finished: nil
+  )
+  end
+
+  # Result is a segment of the result set - multiple of these may be returned
+# in a stream before the final "finished" message.
+  sig { returns(T.nilable(Stately::Db::ListPartialResult)) }
+  def result
+  end
+
+  # Result is a segment of the result set - multiple of these may be returned
+# in a stream before the final "finished" message.
+  sig { params(value: T.nilable(Stately::Db::ListPartialResult)).void }
+  def result=(value)
+  end
+
+  # Result is a segment of the result set - multiple of these may be returned
+# in a stream before the final "finished" message.
+  sig { void }
+  def clear_result
+  end
+
+  # Finished is sent when there are no more results in this operation, and
+# there will only be one.
+  sig { returns(T.nilable(Stately::Db::ListFinished)) }
+  def finished
+  end
+
+  # Finished is sent when there are no more results in this operation, and
+# there will only be one.
+  sig { params(value: T.nilable(Stately::Db::ListFinished)).void }
+  def finished=(value)
+  end
+
+  # Finished is sent when there are no more results in this operation, and
+# there will only be one.
+  sig { void }
+  def clear_finished
+  end
+
+  sig { returns(T.nilable(Symbol)) }
+  def response
+  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(Stately::Db::ListResponse) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::ListResponse).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::ListResponse) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::ListResponse, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+class Stately::Db::ListPartialResult
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      items: T.nilable(T::Array[T.nilable(Stately::Db::Item)])
+    ).void
+  end
+  def initialize(
+    items: []
+  )
+  end
+
+  # results is a list that contains one entry for each Item that was found.
+  sig { returns(T::Array[T.nilable(Stately::Db::Item)]) }
+  def items
+  end
+
+  # results is a list that contains one entry for each Item that was found.
+  sig { params(value: ::Google::Protobuf::RepeatedField).void }
+  def items=(value)
+  end
+
+  # results is a list that contains one entry for each Item that was found.
+  sig { void }
+  def clear_items
+  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(Stately::Db::ListPartialResult) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::ListPartialResult).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::ListPartialResult) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::ListPartialResult, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+class Stately::Db::ListFinished
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      token: T.nilable(Stately::Db::ListToken)
+    ).void
+  end
+  def initialize(
+    token: nil
+  )
+  end
+
+  # token is always set and represents an updated list continuation token that
+# can be used in subsequent calls to ContinueList or SyncList.
+  sig { returns(T.nilable(Stately::Db::ListToken)) }
+  def token
+  end
+
+  # token is always set and represents an updated list continuation token that
+# can be used in subsequent calls to ContinueList or SyncList.
+  sig { params(value: T.nilable(Stately::Db::ListToken)).void }
+  def token=(value)
+  end
+
+  # token is always set and represents an updated list continuation token that
+# can be used in subsequent calls to ContinueList or SyncList.
+  sig { void }
+  def clear_token
+  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(Stately::Db::ListFinished) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::ListFinished).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::ListFinished) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::ListFinished, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end
+
+module Stately::Db::SortDirection
+  self::SORT_ASCENDING = T.let(0, Integer)
+  self::SORT_DESCENDING = T.let(1, Integer)
+
+  sig { params(value: Integer).returns(T.nilable(Symbol)) }
+  def self.lookup(value)
+  end
+
+  sig { params(value: Symbol).returns(T.nilable(Integer)) }
+  def self.resolve(value)
+  end
+
+  sig { returns(::Google::Protobuf::EnumDescriptor) }
+  def self.descriptor
+  end
+end

data/rbi/db/list_token_pb.rbi

@@ -0,0 +1,154 @@
+# Code generated by protoc-gen-rbi. DO NOT EDIT.
+# source: db/list_token.proto
+# typed: strict
+
+# ListToken is an opaque token that can be used to continue (paginate) or sync
+# results from a previous List operation.
+class Stately::Db::ListToken
+  include ::Google::Protobuf::MessageExts
+  extend ::Google::Protobuf::MessageExts::ClassMethods
+
+  sig do
+    params(
+      token_data: T.nilable(String),
+      can_continue: T.nilable(T::Boolean),
+      can_sync: T.nilable(T::Boolean),
+      schema_version_id: T.nilable(Integer)
+    ).void
+  end
+  def initialize(
+    token_data: "",
+    can_continue: false,
+    can_sync: false,
+    schema_version_id: 0
+  )
+  end
+
+  # token_data will always be returned, and can be used to expand the result
+# set via ContinueList (if can_continue is true), or to get changed items
+# within the result set via SyncList (if can_sync is true). The token_data
+# itself is opaque and cannot be parsed or modified by clients.
+  sig { returns(String) }
+  def token_data
+  end
+
+  # token_data will always be returned, and can be used to expand the result
+# set via ContinueList (if can_continue is true), or to get changed items
+# within the result set via SyncList (if can_sync is true). The token_data
+# itself is opaque and cannot be parsed or modified by clients.
+  sig { params(value: String).void }
+  def token_data=(value)
+  end
+
+  # token_data will always be returned, and can be used to expand the result
+# set via ContinueList (if can_continue is true), or to get changed items
+# within the result set via SyncList (if can_sync is true). The token_data
+# itself is opaque and cannot be parsed or modified by clients.
+  sig { void }
+  def clear_token_data
+  end
+
+  # can_continue indicates that there are more results available by expanding
+# the pagination window by calling ContinueList with this token.
+  sig { returns(T::Boolean) }
+  def can_continue
+  end
+
+  # can_continue indicates that there are more results available by expanding
+# the pagination window by calling ContinueList with this token.
+  sig { params(value: T::Boolean).void }
+  def can_continue=(value)
+  end
+
+  # can_continue indicates that there are more results available by expanding
+# the pagination window by calling ContinueList with this token.
+  sig { void }
+  def clear_can_continue
+  end
+
+  # can_sync indicates that you could call SyncList with this token later to
+# get updated items. This is determined by the type of store you're listing
+# from.
+  sig { returns(T::Boolean) }
+  def can_sync
+  end
+
+  # can_sync indicates that you could call SyncList with this token later to
+# get updated items. This is determined by the type of store you're listing
+# from.
+  sig { params(value: T::Boolean).void }
+  def can_sync=(value)
+  end
+
+  # can_sync indicates that you could call SyncList with this token later to
+# get updated items. This is determined by the type of store you're listing
+# from.
+  sig { void }
+  def clear_can_sync
+  end
+
+  # schema_version_id represents the version of the schema that was used to
+# generate token_data. For ContinueList calls, you must ensure the client's
+# schema version and this field are the same. A mismatch between the two
+# will result in a SchemaVersionMismatch error. For SyncList calls, you
+# only need to ensure you handle Reset events correctly by clearing your
+# local state and consuming a new list of items as Stately will handle
+# re-send items in the correct version along with a new token at the end.
+  sig { returns(Integer) }
+  def schema_version_id
+  end
+
+  # schema_version_id represents the version of the schema that was used to
+# generate token_data. For ContinueList calls, you must ensure the client's
+# schema version and this field are the same. A mismatch between the two
+# will result in a SchemaVersionMismatch error. For SyncList calls, you
+# only need to ensure you handle Reset events correctly by clearing your
+# local state and consuming a new list of items as Stately will handle
+# re-send items in the correct version along with a new token at the end.
+  sig { params(value: Integer).void }
+  def schema_version_id=(value)
+  end
+
+  # schema_version_id represents the version of the schema that was used to
+# generate token_data. For ContinueList calls, you must ensure the client's
+# schema version and this field are the same. A mismatch between the two
+# will result in a SchemaVersionMismatch error. For SyncList calls, you
+# only need to ensure you handle Reset events correctly by clearing your
+# local state and consuming a new list of items as Stately will handle
+# re-send items in the correct version along with a new token at the end.
+  sig { void }
+  def clear_schema_version_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(Stately::Db::ListToken) }
+  def self.decode(str)
+  end
+
+  sig { params(msg: Stately::Db::ListToken).returns(String) }
+  def self.encode(msg)
+  end
+
+  sig { params(str: String, kw: T.untyped).returns(Stately::Db::ListToken) }
+  def self.decode_json(str, **kw)
+  end
+
+  sig { params(msg: Stately::Db::ListToken, kw: T.untyped).returns(String) }
+  def self.encode_json(msg, **kw)
+  end
+
+  sig { returns(::Google::Protobuf::Descriptor) }
+  def self.descriptor
+  end
+end