Python

基础 API

yr.init	初始化客户端，根据配置连接到 openYuanrong 集群。
yr.is_initialized	检查是否已调用 init 接口完成初始化。
yr.finalize	关闭客户端，释放函数实例等创建的资源。
yr.Config	init 接口使用的配置参数。
yr.config.ClientInfo	用于存储 openYuanrong 客户端信息。

有状态及无状态函数 API

yr.invoke	定义一个无状态函数。
yr.StatelessFunction	无状态函数句柄（推荐），使用它执行调用。
yr.FunctionProxy	无状态函数句柄（已弃用，请使用 StatelessFunction），使用它执行调用。
yr.instance	定义一个有状态函数。
yr.StatefulInstanceCreator	用于创建有状态函数实例（推荐）。
yr.StatefulInstance	有状态函数实例的句柄（推荐），用于终止实例等操作。
yr.InstanceCreator	用于创建有状态函数实例（已弃用，请使用 StatefulInstanceCreator）。
yr.InstanceProxy	有状态函数实例的句柄（已弃用，请使用 StatefulInstance），用于终止实例等操作。
yr.method	定义有状态函数的方法。
yr.MethodProxy	有状态函数实例的方法句柄，使用它执行调用。
yr.get_instance	根据具名实例的 name 和 namespace 获取实例句柄。
yr.cancel	取消无状态函数调用。
yr.exit	退出当前函数实例。
yr.save_state	保存有状态函数实例的状态。
yr.load_state	导入有状态函数实例的状态。
yr.InvokeOptions	用于设置调用选项。

数据对象 API

yr.put	保存数据对象到数据系统。
yr.get	根据数据对象的键从数据系统中检索值。
yr.wait	给定一组数据对象的键，等待指定数量的数据对象的值就绪。
yr.object_ref.ObjectRef	对象引用，即数据对象的键。

数据流 API

yr.ProducerConfig	生产者创建的配置类。
yr.SubscriptionConfig	消费者订阅的配置类。
yr.Element	包含元素 ID 与数据缓冲区的元素类。
yr.create_stream_producer	创建生产者。
yr.create_stream_consumer	创建消费者。
yr.delete_stream	删除数据流。
yr.fnruntime.Producer	生产者接口类。
yr.fnruntime.Consumer	消费者接口类。

函数互调 API

yr.cpp_function	用于构造 cpp 函数的代理，远程调用 cpp 函数。
yr.cpp_instance_class	为 cpp 类构造代理以启用远程调用。
yr.java_function	用于构造 java 函数的代理，远程调用 java 函数。
yr.java_instance_class	用于构造 Java 类，并远程调用 Java 类的代理。

函数组 API

yr.create_function_group	创建函数组实例。
yr.get_function_group_context	获取函数实例的函数组上下文。
yr.FunctionGroupOptions	函数组的配置项。
yr.FunctionGroupContext	用于管理函数组信息的上下文。
yr.FunctionGroupHandler	函数组句柄，用于终止实例组等操作。
yr.FunctionGroupMethodProxy	函数组的方法句柄，使用它执行调用。
yr.device.DataInfo	DataInfo 类用于存储数据的基本信息。

资源组 API

yr.create_resource_group	异步创建一个 ResourceGroup。
yr.remove_resource_group	异步删除一个 ResourceGroup。
yr.ResourceGroup	创建 ResourceGroup 后返回的句柄。
yr.config.ResourceGroupOptions	资源组选项。
yr.config.SchedulingAffinityType	调度亲和性类型，用于定义资源组的调度策略。
yr.config.UserTLSConfig	用户 SSL/TLS 配置。
yr.config.DeploymentConfig	自动部署配置类。

成组 API

yr.Group	一个用于管理实例分组生命周期的类。
yr.config.GroupOptions	分组实例调度的配置选项。

KV 缓存 API

警告

yr.kv_m_write_tx 和 yr.MSetParam 已废弃，仅为兼容历史版本保留。新代码请勿继续使用。

yr.kv_write	提供类 Redis 的 set 存储接口，支持保存二进制数据到数据系统。
yr.kv_write_with_param	提供支持自定义参数配置的存储接口。用于以更灵活的方式将二进制数据写入数据系统。
yr.kv_m_write_tx	已废弃，仅为兼容历史版本保留。
yr.kv_read	提供类 Redis 的 get 获取数据接口，支持同时获取多个数据。
yr.kv_del	提供类 Redis 的 del 删除数据接口，支持同时删除多个数据。
yr.kv_set	提供类似 Redis 的集合存储接口，支持二进制数据保存到数据系统。
yr.kv_get	提供类 Redis 的 get 获取数据接口，支持同时获取多个数据。
yr.kv_get_with_param	提供支持偏移读的接口 kv_get_with_param, 支持偏移读取数据。
yr.ExistenceOpt	Kv 选项。
yr.WriteMode	对象写入模式。
yr.CacheType	缓存类型。
yr.ConsistencyType	一致性类型。
yr.GetParam	获取参数配置类。
yr.GetParams	获取参数的接口类。
yr.SetParam	设置参数。
yr.MSetParam	已废弃，仅为兼容历史版本保留。
yr.CreateParam	创建参数。

可观测性 API

yr.Gauge	用于上报 Metrics 数据。
yr.Alarm	用于设置和管理告警信息。
yr.AlarmInfo	告警信息。
yr.AlarmSeverity	资源组选项。
yr.DoubleCounter	用于记录双精度浮点数计数器的指标。
yr.UInt64Counter	用于记录 64 位无符号整数计数器的指标。
yr.resources	获取集群中节点的资源信息。

亲和调度

yr.affinity.AffinityType	亲和类型枚举。
yr.affinity.AffinityKind	亲和种类枚举。
yr.affinity.OperatorType	标签操作符类型枚举。
yr.affinity.LabelOperator	亲和的标签操作符。
yr.affinity.Affinity	表示一个亲和配置。

异常

yr.exception.YRError	YR 模块中所有自定义异常的基类，承载结构化错误信息。
yr.exception.YRRuntimeError	结构化运行时错误，兼容 Python 内置 RuntimeError 捕获。
yr.exception.YRTimeoutError	结构化超时错误，兼容 Python 内置 TimeoutError 捕获。
yr.exception.YRValueError	结构化参数取值错误，兼容 Python 内置 ValueError 捕获。
yr.exception.YRTypeError	结构化参数类型错误，兼容 Python 内置 TypeError 捕获。
yr.exception.CancelError	任务取消错误。
yr.exception.YRInvokeError	表示在调用期间发生的错误。
yr.exception.YRequestError	请求失败错误。