AS AgentScopeAPI 手册 / API Reference

Builder

public static final class Builder extends com.google.protobuf.GeneratedMessage.Builder<Builder> implements io.agentscope.controlplane.proto.EventReportOrBuilder
源码Source io/agentscope/controlplane/proto/EventReport.java:319–851

构建器,用于构建并配置目标实例。位于 io.agentscope.controlplane.proto 包,继承自 com.google.protobuf.GeneratedMessage.Builder<Builder>,实现 io.agentscope.controlplane.proto.EventReportOrBuilder。核心成员包括 getDescriptor、internalGetFieldAccessorTable、clear、getDescriptorForType、getDefaultInstanceForType、build。


EventReport is the Level-2 event stream report (batched, e.g. every 5s or
every 20 events). Written by the control plane into the session_events table.

Protobuf type agentscope.protocol.v1.EventReport

方法摘要Method Summary

方法Method说明Description
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
staticfinal
获取描述符。
Returns the descriptor.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
返回 `internalGetFieldAccessorTable` 结果。
Returns the internal get field accessor table.
public Builder clear()
清空或重置内部状态。
Clears or resets internal state.
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
获取 `getDescriptorForType`。
Returns the descriptor for type.
public io.agentscope.controlplane.proto.EventReport getDefaultInstanceForType()
获取默认实例用于类型。
Returns the default instance for type.
public io.agentscope.controlplane.proto.EventReport build()
构建并返回最终实例。
Creates and returns an instance.
public io.agentscope.controlplane.proto.EventReport buildPartial()
构建 `buildPartial`。
Builds the partial.
public Builder mergeFrom(com.google.protobuf.Message other)
设置该配置项。
Performs the merge from operation.
public Builder mergeFrom(io.agentscope.controlplane.proto.EventReport other)
设置该配置项。
Performs the merge from operation.
public final boolean isInitialized()
final
判断是否已初始化。
Returns whether the initialized.
public Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
设置该配置项。
Performs the merge from operation.
public java.util.List<io.agentscope.controlplane.proto.SessionEventMsg> getEventsList()
获取事件列表。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public int getEventsCount()
获取事件数量。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public io.agentscope.controlplane.proto.SessionEventMsg getEvents(int index)
获取事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder setEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg value)
设置设置事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder setEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg.Builder builderForValue)
设置设置事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder addEvents(io.agentscope.controlplane.proto.SessionEventMsg value)
添加事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder addEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg value)
添加事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder addEvents(io.agentscope.controlplane.proto.SessionEventMsg.Builder builderForValue)
添加事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder addEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg.Builder builderForValue)
添加事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder addAllEvents(java.lang.Iterable<? extends io.agentscope.controlplane.proto.SessionEventMsg> values)
添加所有事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder clearEvents()
清空事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public Builder removeEvents(int index)
移除事件。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public io.agentscope.controlplane.proto.SessionEventMsg.Builder getEventsBuilder(int index)
获取事件构建器。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public io.agentscope.controlplane.proto.SessionEventMsgOrBuilder getEventsOrBuilder(int index)
获取事件或构建器。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public java.util.List<? extends io.agentscope.controlplane.proto.SessionEventMsgOrBuilder> getEventsOrBuilderList()
获取事件或构建器列表。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public io.agentscope.controlplane.proto.SessionEventMsg.Builder addEventsBuilder()
添加事件构建器。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public io.agentscope.controlplane.proto.SessionEventMsg.Builder addEventsBuilder(int index)
添加事件构建器。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public java.util.List<io.agentscope.controlplane.proto.SessionEventMsg.Builder> getEventsBuilderList()
获取事件构建器列表。
`repeated .agentscope.protocol.v1.SessionEventMsg events = 1;`
public java.lang.String getReportId()
获取报告标识。
``` Stable across retries.
public com.google.protobuf.ByteString getReportIdBytes()
获取报告标识字节。
``` Stable across retries.
public Builder setReportId(java.lang.String value)
设置设置报告标识。
``` Stable across retries.
public Builder clearReportId()
清空报告标识。
``` Stable across retries.
public Builder setReportIdBytes(com.google.protobuf.ByteString value)
设置设置报告标识字节。
``` Stable across retries.

方法详情Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
staticfinal

获取描述符。

Returns the descriptor.

返回Returns com.google.protobuf.Descriptors.Descriptor
返回com.google.protobuf.Descriptors.Descriptor。Returns com google protobuf descriptors descriptor.
源码Source io/agentscope/controlplane/proto/EventReport.java:323–326

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

返回 internalGetFieldAccessorTable 结果。

Returns the internal get field accessor table.

返回Returns com.google.protobuf.GeneratedMessage.FieldAccessorTable
返回com.google.protobuf.GeneratedMessage.FieldAccessorTable。Returns com google protobuf generated message field accessor table.
源码Source io/agentscope/controlplane/proto/EventReport.java:328–334

clear

public Builder clear()

清空或重置内部状态。

Clears or resets internal state.

返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:346–359

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

获取 getDescriptorForType。

Returns the descriptor for type.

返回Returns com.google.protobuf.Descriptors.Descriptor
返回com.google.protobuf.Descriptors.Descriptor。Returns com google protobuf descriptors descriptor.
源码Source io/agentscope/controlplane/proto/EventReport.java:361–365

getDefaultInstanceForType

public io.agentscope.controlplane.proto.EventReport getDefaultInstanceForType()

获取默认实例用于类型。

Returns the default instance for type.

返回Returns io.agentscope.controlplane.proto.EventReport
返回io.agentscope.controlplane.协议.EventReport。Returns io agentscope controlplane proto event report.
源码Source io/agentscope/controlplane/proto/EventReport.java:367–370

build

public io.agentscope.controlplane.proto.EventReport build()

构建并返回最终实例。

Creates and returns an instance.

返回Returns io.agentscope.controlplane.proto.EventReport
返回io.agentscope.controlplane.协议.EventReport。Returns io agentscope controlplane proto event report.
源码Source io/agentscope/controlplane/proto/EventReport.java:372–379

buildPartial

public io.agentscope.controlplane.proto.EventReport buildPartial()

构建 buildPartial。

Builds the partial.

返回Returns io.agentscope.controlplane.proto.EventReport
返回io.agentscope.controlplane.协议.EventReport。Returns io agentscope controlplane proto event report.
源码Source io/agentscope/controlplane/proto/EventReport.java:381–388

mergeFrom

public Builder mergeFrom(com.google.protobuf.Message other)

设置该配置项。

Performs the merge from operation.

参数Parameters
名称Name类型Type说明Description
othercom.google.protobuf.Messageother(类型 `com.google.protobuf.Message`)。The other.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:409–417

mergeFrom

public Builder mergeFrom(io.agentscope.controlplane.proto.EventReport other)

设置该配置项。

Performs the merge from operation.

参数Parameters
名称Name类型Type说明Description
otherio.agentscope.controlplane.proto.EventReportother(类型 `io.agentscope.controlplane.proto.EventReport`)。The other.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:419–455

isInitialized

public final boolean isInitialized()
final

判断是否已初始化。

Returns whether the initialized.

返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/controlplane/proto/EventReport.java:457–460

mergeFrom

public Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException

设置该配置项。

Performs the merge from operation.

参数Parameters
名称Name类型Type说明Description
inputcom.google.protobuf.CodedInputStream输入消息(类型 `com.google.protobuf.CodedInputStream`)。The input.
extensionRegistrycom.google.protobuf.ExtensionRegistryLite扩展注册表(类型 `com.google.protobuf.ExtensionRegistryLite`)。The extension registry.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
抛出Throws
  • java.io.IOException 可能抛出 `java.io.IOException`。Thrown when the operation cannot be completed.
源码Source io/agentscope/controlplane/proto/EventReport.java:462–510

getEventsList

public java.util.List<io.agentscope.controlplane.proto.SessionEventMsg> getEventsList()

获取事件列表。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

返回Returns java.util.List<io.agentscope.controlplane.proto.SessionEventMsg>
返回java.util.列出。Returns java util list.
源码Source io/agentscope/controlplane/proto/EventReport.java:528–534

getEventsCount

public int getEventsCount()

获取事件数量。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

返回Returns int
返回数值结果。Returns a numeric result.
源码Source io/agentscope/controlplane/proto/EventReport.java:538–544

getEvents

public io.agentscope.controlplane.proto.SessionEventMsg getEvents(int index)

获取事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
返回Returns io.agentscope.controlplane.proto.SessionEventMsg
返回io.agentscope.controlplane.协议.SessionEventMsg。Returns io agentscope controlplane proto session event msg.
源码Source io/agentscope/controlplane/proto/EventReport.java:548–554

setEvents

public Builder setEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg value)

设置设置事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
valueio.agentscope.controlplane.proto.SessionEventMsg值(类型 `io.agentscope.controlplane.proto.SessionEventMsg`)。The value.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:558–571

setEvents

public Builder setEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg.Builder builderForValue)

设置设置事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
builderForValueio.agentscope.controlplane.proto.SessionEventMsg.Builder构建器用于值(类型 `io.agentscope.controlplane.proto.SessionEventMsg.Builder`)。The builder for value.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:575–585

addEvents

public Builder addEvents(io.agentscope.controlplane.proto.SessionEventMsg value)

添加事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
valueio.agentscope.controlplane.proto.SessionEventMsg值(类型 `io.agentscope.controlplane.proto.SessionEventMsg`)。The value.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:589–601

addEvents

public Builder addEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg value)

添加事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
valueio.agentscope.controlplane.proto.SessionEventMsg值(类型 `io.agentscope.controlplane.proto.SessionEventMsg`)。The value.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:605–618

addEvents

public Builder addEvents(io.agentscope.controlplane.proto.SessionEventMsg.Builder builderForValue)

添加事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
builderForValueio.agentscope.controlplane.proto.SessionEventMsg.Builder构建器用于值(类型 `io.agentscope.controlplane.proto.SessionEventMsg.Builder`)。The builder for value.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:622–632

addEvents

public Builder addEvents(int index, io.agentscope.controlplane.proto.SessionEventMsg.Builder builderForValue)

添加事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
builderForValueio.agentscope.controlplane.proto.SessionEventMsg.Builder构建器用于值(类型 `io.agentscope.controlplane.proto.SessionEventMsg.Builder`)。The builder for value.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:636–646

addAllEvents

public Builder addAllEvents(java.lang.Iterable<? extends io.agentscope.controlplane.proto.SessionEventMsg> values)

添加所有事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
valuesjava.lang.Iterable<? extends io.agentscope.controlplane.proto.SessionEventMsg>值(类型 `java.lang.Iterable`)。The values.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:650–661

clearEvents

public Builder clearEvents()

清空事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:665–674

removeEvents

public Builder removeEvents(int index)

移除事件。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:678–687

getEventsBuilder

public io.agentscope.controlplane.proto.SessionEventMsg.Builder getEventsBuilder(int index)

获取事件构建器。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
返回Returns io.agentscope.controlplane.proto.SessionEventMsg.Builder
返回io.agentscope.controlplane.协议.SessionEventMsg.构建器。Returns io agentscope controlplane proto session event msg builder.
源码Source io/agentscope/controlplane/proto/EventReport.java:691–694

getEventsOrBuilder

public io.agentscope.controlplane.proto.SessionEventMsgOrBuilder getEventsOrBuilder(int index)

获取事件或构建器。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
返回Returns io.agentscope.controlplane.proto.SessionEventMsgOrBuilder
返回io.agentscope.controlplane.协议.SessionEventMsgOrBuilder。Returns io agentscope controlplane proto session event msg or builder.
源码Source io/agentscope/controlplane/proto/EventReport.java:698–704

getEventsOrBuilderList

public java.util.List<? extends io.agentscope.controlplane.proto.SessionEventMsgOrBuilder> getEventsOrBuilderList()

获取事件或构建器列表。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

返回Returns java.util.List<? extends io.agentscope.controlplane.proto.SessionEventMsgOrBuilder>
返回java.util.列出。Returns java util list.
源码Source io/agentscope/controlplane/proto/EventReport.java:708–715

addEventsBuilder

public io.agentscope.controlplane.proto.SessionEventMsg.Builder addEventsBuilder()

添加事件构建器。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

返回Returns io.agentscope.controlplane.proto.SessionEventMsg.Builder
返回io.agentscope.controlplane.协议.SessionEventMsg.构建器。Returns io agentscope controlplane proto session event msg builder.
源码Source io/agentscope/controlplane/proto/EventReport.java:719–722

addEventsBuilder

public io.agentscope.controlplane.proto.SessionEventMsg.Builder addEventsBuilder(int index)

添加事件构建器。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

参数Parameters
名称Name类型Type说明Description
indexint索引(类型 `int`)。The index.
返回Returns io.agentscope.controlplane.proto.SessionEventMsg.Builder
返回io.agentscope.controlplane.协议.SessionEventMsg.构建器。Returns io agentscope controlplane proto session event msg builder.
源码Source io/agentscope/controlplane/proto/EventReport.java:726–730

getEventsBuilderList

public java.util.List<io.agentscope.controlplane.proto.SessionEventMsg.Builder> getEventsBuilderList()

获取事件构建器列表。

repeated .agentscope.protocol.v1.SessionEventMsg events = 1;

返回Returns java.util.List<io.agentscope.controlplane.proto.SessionEventMsg.Builder>
返回java.util.列出。Returns java util list.
源码Source io/agentscope/controlplane/proto/EventReport.java:734–737

getReportId

public java.lang.String getReportId()

获取报告标识。

Stable across retries.

返回Returns java.lang.String
返回java.lang.String。The reportId.
源码Source io/agentscope/controlplane/proto/EventReport.java:763–774

getReportIdBytes

public com.google.protobuf.ByteString getReportIdBytes()

获取报告标识字节。

Stable across retries.

返回Returns com.google.protobuf.ByteString
字节用于 reportId。The bytes for reportId.
源码Source io/agentscope/controlplane/proto/EventReport.java:784–796

setReportId

public Builder setReportId(java.lang.String value)

设置设置报告标识。

Stable across retries.

参数Parameters
名称Name类型Type说明Description
valuejava.lang.StringreportId 到设置。The reportId to set.
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:807–814

clearReportId

public Builder clearReportId()

清空报告标识。

Stable across retries.

返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:824–829

setReportIdBytes

public Builder setReportIdBytes(com.google.protobuf.ByteString value)

设置设置报告标识字节。

Stable across retries.

参数Parameters
名称Name类型Type说明Description
valuecom.google.protobuf.ByteString字节用于 reportId 到设置。The bytes for reportId to set.
返回Returns Builder
返回当前实例,以支持链式调用。This builder for chaining.
源码Source io/agentscope/controlplane/proto/EventReport.java:840–848
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.