Modules§
- actor_
count_ per_ parallelism - Nested message and enum types in
ActorCountPerParallelism
. - add_
event_ log_ request - Nested message and enum types in
AddEventLogRequest
. - cancel_
creating_ jobs_ request - Nested message and enum types in
CancelCreatingJobsRequest
. - cluster_
limit - Nested message and enum types in
ClusterLimit
. - cluster_
limit_ service_ client - Generated client implementations.
- cluster_
limit_ service_ server - Generated server implementations.
- cluster_
service_ client - Generated client implementations.
- cluster_
service_ server - Generated server implementations.
- event_
log - Nested message and enum types in
EventLog
. - event_
log_ service_ client - Generated client implementations.
- event_
log_ service_ server - Generated server implementations.
- get_
serverless_ streaming_ jobs_ status_ response - Nested message and enum types in
GetServerlessStreamingJobsStatusResponse
. - heartbeat_
service_ client - Generated client implementations.
- heartbeat_
service_ server - Generated server implementations.
- hosted_
iceberg_ catalog_ service_ client - Generated client implementations.
- hosted_
iceberg_ catalog_ service_ server - Generated server implementations.
- list_
actor_ splits_ response - Nested message and enum types in
ListActorSplitsResponse
. - list_
actor_ states_ response - Nested message and enum types in
ListActorStatesResponse
. - list_
fragment_ distribution_ response - Nested message and enum types in
ListFragmentDistributionResponse
. - list_
iceberg_ tables_ response - Nested message and enum types in
ListIcebergTablesResponse
. - list_
object_ dependencies_ response - Nested message and enum types in
ListObjectDependenciesResponse
. - list_
rate_ limits_ response - Nested message and enum types in
ListRateLimitsResponse
. - list_
streaming_ job_ states_ response - Nested message and enum types in
ListStreamingJobStatesResponse
. - list_
table_ fragments_ response - Nested message and enum types in
ListTableFragmentsResponse
. - meta_
member_ service_ client - Generated client implementations.
- meta_
member_ service_ server - Generated server implementations.
- meta_
snapshot - Nested message and enum types in
MetaSnapshot
. - notification_
service_ client - Generated client implementations.
- notification_
service_ server - Generated server implementations.
- object
- Nested message and enum types in
Object
. - scale_
service_ client - Generated client implementations.
- scale_
service_ server - Generated server implementations.
- serving_
service_ client - Generated client implementations.
- serving_
service_ server - Generated server implementations.
- session_
param_ service_ client - Generated client implementations.
- session_
param_ service_ server - Generated server implementations.
- stream_
manager_ service_ client - Generated client implementations.
- stream_
manager_ service_ server - Generated server implementations.
- subscribe_
response - Nested message and enum types in
SubscribeResponse
. - system_
params_ service_ client - Generated client implementations.
- system_
params_ service_ server - Generated server implementations.
- table_
fragments - Nested message and enum types in
TableFragments
. - table_
parallelism - Nested message and enum types in
TableParallelism
. - telemetry_
info_ service_ client - Generated client implementations.
- telemetry_
info_ service_ server - Generated server implementations.
- update_
worker_ node_ schedulability_ request - Nested message and enum types in
UpdateWorkerNodeSchedulabilityRequest
.
Structs§
- Activate
Worker Node Request - Activate
Worker Node Response - Actor
Count PerParallelism - Actor
Ids - Actor
Location - TODO: remove this when dashboard refactored.
- AddEvent
LogRequest - AddEvent
LogResponse - AddWorker
Node Request - Below for cluster service.
- AddWorker
Node Response - Apply
Throttle Request - Apply
Throttle Response - Cancel
Creating Jobs Request - Cancel
Creating Jobs Response - Cluster
Limit - Delete
Worker Node Request - Delete
Worker Node Response - Event
Log - Flush
Request - Flush
Response - Fragment
IdTo Actor IdMap - Fragment
ToRelation Map - Fragment
Worker Slot Mapping - / Worker slot mapping with fragment id, used for notification.
- Fragment
Worker Slot Mappings - GetCluster
Info Request - GetCluster
Info Response - GetCluster
Limits Request - GetCluster
Limits Response - GetCluster
Recovery Status Request - GetCluster
Recovery Status Response - GetMeta
Store Info Request - GetMeta
Store Info Response - GetServerless
Streaming Jobs Status Request - GetServerless
Streaming Jobs Status Response - Descriptions of MVs and sinks
- GetServing
Vnode Mappings Request - GetServing
Vnode Mappings Response - GetSession
Params Request - GetSession
Params Response - GetSystem
Params Request - GetSystem
Params Response - GetTelemetry
Info Request - Heartbeat
Request - Heartbeat
Response - List
Actor Splits Request - List
Actor Splits Response - List
Actor States Request - List
Actor States Response - List
AllNodes Request - List
AllNodes Response - List
Event LogRequest - List
Event LogResponse - List
Fragment Distribution Request - List
Fragment Distribution Response - List
Iceberg Tables Request - List
Iceberg Tables Response - List
Object Dependencies Request - List
Object Dependencies Response - List
Rate Limits Request - List
Rate Limits Response - List
Streaming JobStates Request - List
Streaming JobStates Response - List
Table Fragments Request - List
Table Fragments Response - Members
Request - Members
Response - Meta
Member - Meta
Snapshot - Migration
Plan - Object
- Object
Group - Pause
Request - Pause
Response - Recover
Request - Recover
Response - Recovery
- Relation
IdInfos - / Provides all the ids: relation_id, fragment_id, actor_id / in an hierarchical format. / relation_id -> [fragment_id] / fragment_id -> [actor_id]
- Reschedule
Request - Reschedule
Response - Resume
Request - Resume
Response - SetSession
Param Request - SetSession
Param Response - SetSystem
Param Request - SetSystem
Param Response - Subscribe
Request - Below for notification service.
- Subscribe
Response - System
Params - The schema for persisted system parameters. Note on backward compatibility:
- Table
Fragments - Fragments of a Streaming Job.
It’s for all kinds of streaming jobs, and ideally should be called
StreamingJobFragments
. It’s not the same as a storage table correlated with aTableCatalog
. - Table
Parallelism - Telemetry
Info Response - Update
Streaming JobNode Labels Request - Changes a streaming job in place by overwriting its node_label. This may cause the re-scheduling of the streaming job actors.
- Update
Streaming JobNode Labels Response - We do not need to add an explicit status field here, we can just use the RPC status
- Update
Worker Node Schedulability Request - Mark CN as schedulable or as unschedulable
- Update
Worker Node Schedulability Response - Worker
Reschedule - For each fragment that needs to be rescheduled, there will be a WorkerReschedule, indicating on which workers the actors of this fragment need to be changed and by how many.
Enums§
Type Aliases§
- PbActivate
Worker Node Request - Alias for
ActivateWorkerNodeRequest
. - PbActivate
Worker Node Response - Alias for
ActivateWorkerNodeResponse
. - PbActor
Count PerParallelism - Alias for
ActorCountPerParallelism
. - PbActor
Ids - Alias for
ActorIds
. - PbActor
Location - Alias for
ActorLocation
. - PbAdd
Event LogRequest - Alias for
AddEventLogRequest
. - PbAdd
Event LogResponse - Alias for
AddEventLogResponse
. - PbAdd
Worker Node Request - Alias for
AddWorkerNodeRequest
. - PbAdd
Worker Node Response - Alias for
AddWorkerNodeResponse
. - PbApply
Throttle Request - Alias for
ApplyThrottleRequest
. - PbApply
Throttle Response - Alias for
ApplyThrottleResponse
. - PbCancel
Creating Jobs Request - Alias for
CancelCreatingJobsRequest
. - PbCancel
Creating Jobs Response - Alias for
CancelCreatingJobsResponse
. - PbCluster
Limit - Alias for
ClusterLimit
. - PbDelete
Worker Node Request - Alias for
DeleteWorkerNodeRequest
. - PbDelete
Worker Node Response - Alias for
DeleteWorkerNodeResponse
. - PbEvent
Log - Alias for
EventLog
. - PbFlush
Request - Alias for
FlushRequest
. - PbFlush
Response - Alias for
FlushResponse
. - PbFragment
IdTo Actor IdMap - Alias for
FragmentIdToActorIdMap
. - PbFragment
ToRelation Map - Alias for
FragmentToRelationMap
. - PbFragment
Worker Slot Mapping - Alias for
FragmentWorkerSlotMapping
. - PbFragment
Worker Slot Mappings - Alias for
FragmentWorkerSlotMappings
. - PbGet
Cluster Info Request - Alias for
GetClusterInfoRequest
. - PbGet
Cluster Info Response - Alias for
GetClusterInfoResponse
. - PbGet
Cluster Limits Request - Alias for
GetClusterLimitsRequest
. - PbGet
Cluster Limits Response - Alias for
GetClusterLimitsResponse
. - PbGet
Cluster Recovery Status Request - Alias for
GetClusterRecoveryStatusRequest
. - PbGet
Cluster Recovery Status Response - Alias for
GetClusterRecoveryStatusResponse
. - PbGet
Meta Store Info Request - Alias for
GetMetaStoreInfoRequest
. - PbGet
Meta Store Info Response - Alias for
GetMetaStoreInfoResponse
. - PbGet
Serverless Streaming Jobs Status Request - Alias for
GetServerlessStreamingJobsStatusRequest
. - PbGet
Serverless Streaming Jobs Status Response - Alias for
GetServerlessStreamingJobsStatusResponse
. - PbGet
Serving Vnode Mappings Request - Alias for
GetServingVnodeMappingsRequest
. - PbGet
Serving Vnode Mappings Response - Alias for
GetServingVnodeMappingsResponse
. - PbGet
Session Params Request - Alias for
GetSessionParamsRequest
. - PbGet
Session Params Response - Alias for
GetSessionParamsResponse
. - PbGet
System Params Request - Alias for
GetSystemParamsRequest
. - PbGet
System Params Response - Alias for
GetSystemParamsResponse
. - PbGet
Telemetry Info Request - Alias for
GetTelemetryInfoRequest
. - PbHeartbeat
Request - Alias for
HeartbeatRequest
. - PbHeartbeat
Response - Alias for
HeartbeatResponse
. - PbList
Actor Splits Request - Alias for
ListActorSplitsRequest
. - PbList
Actor Splits Response - Alias for
ListActorSplitsResponse
. - PbList
Actor States Request - Alias for
ListActorStatesRequest
. - PbList
Actor States Response - Alias for
ListActorStatesResponse
. - PbList
AllNodes Request - Alias for
ListAllNodesRequest
. - PbList
AllNodes Response - Alias for
ListAllNodesResponse
. - PbList
Event LogRequest - Alias for
ListEventLogRequest
. - PbList
Event LogResponse - Alias for
ListEventLogResponse
. - PbList
Fragment Distribution Request - Alias for
ListFragmentDistributionRequest
. - PbList
Fragment Distribution Response - Alias for
ListFragmentDistributionResponse
. - PbList
Iceberg Tables Request - Alias for
ListIcebergTablesRequest
. - PbList
Iceberg Tables Response - Alias for
ListIcebergTablesResponse
. - PbList
Object Dependencies Request - Alias for
ListObjectDependenciesRequest
. - PbList
Object Dependencies Response - Alias for
ListObjectDependenciesResponse
. - PbList
Rate Limits Request - Alias for
ListRateLimitsRequest
. - PbList
Rate Limits Response - Alias for
ListRateLimitsResponse
. - PbList
Streaming JobStates Request - Alias for
ListStreamingJobStatesRequest
. - PbList
Streaming JobStates Response - Alias for
ListStreamingJobStatesResponse
. - PbList
Table Fragments Request - Alias for
ListTableFragmentsRequest
. - PbList
Table Fragments Response - Alias for
ListTableFragmentsResponse
. - PbMembers
Request - Alias for
MembersRequest
. - PbMembers
Response - Alias for
MembersResponse
. - PbMeta
Member - Alias for
MetaMember
. - PbMeta
Snapshot - Alias for
MetaSnapshot
. - PbMigration
Plan - Alias for
MigrationPlan
. - PbObject
- Alias for
Object
. - PbObject
Group - Alias for
ObjectGroup
. - PbPause
Request - Alias for
PauseRequest
. - PbPause
Response - Alias for
PauseResponse
. - PbRecover
Request - Alias for
RecoverRequest
. - PbRecover
Response - Alias for
RecoverResponse
. - PbRecovery
- Alias for
Recovery
. - PbRecovery
Status - Alias for
RecoveryStatus
. - PbRelation
IdInfos - Alias for
RelationIdInfos
. - PbReschedule
Request - Alias for
RescheduleRequest
. - PbReschedule
Response - Alias for
RescheduleResponse
. - PbResume
Request - Alias for
ResumeRequest
. - PbResume
Response - Alias for
ResumeResponse
. - PbSet
Session Param Request - Alias for
SetSessionParamRequest
. - PbSet
Session Param Response - Alias for
SetSessionParamResponse
. - PbSet
System Param Request - Alias for
SetSystemParamRequest
. - PbSet
System Param Response - Alias for
SetSystemParamResponse
. - PbSubscribe
Request - Alias for
SubscribeRequest
. - PbSubscribe
Response - Alias for
SubscribeResponse
. - PbSubscribe
Type - Alias for
SubscribeType
. - PbSystem
Params - Alias for
SystemParams
. - PbTable
Fragments - Alias for
TableFragments
. - PbTable
Parallelism - Alias for
TableParallelism
. - PbTelemetry
Info Response - Alias for
TelemetryInfoResponse
. - PbThrottle
Target - Alias for
ThrottleTarget
. - PbUpdate
Streaming JobNode Labels Request - Alias for
UpdateStreamingJobNodeLabelsRequest
. - PbUpdate
Streaming JobNode Labels Response - Alias for
UpdateStreamingJobNodeLabelsResponse
. - PbUpdate
Worker Node Schedulability Request - Alias for
UpdateWorkerNodeSchedulabilityRequest
. - PbUpdate
Worker Node Schedulability Response - Alias for
UpdateWorkerNodeSchedulabilityResponse
. - PbWorker
Reschedule - Alias for
WorkerReschedule
.