Skip to main content

Module api

Module api 

Source

Modules§

batch_get_locator_delimiters_entry
batch_get_locator_delimiters_request
batch_get_locator_delimiters_response
batch_search_channels_entry
batch_search_channels_request
batch_search_channels_response
batched_channel_entry
batched_locator
batched_locator_channel_metadata
batched_locator_with_delimiter
channel_child_entry
channel_entry
channel_search_data_frame
channel_search_query
get_locator_delimiters_request
get_locator_delimiters_response
list_channel_children_request
list_channel_children_response
locator
locator_channel_metadata
locator_with_delimiter
prefix_entry
search_channels_request
search_channels_response

Structs§

BatchGetLocatorDelimitersEntry
BatchGetLocatorDelimitersRequest
Batched form of getLocatorDelimiters. The map key of requests can be an arbitrary string identifier. It will be returned in the response as part of BatchedLocatorWithDelimiter.
BatchGetLocatorDelimitersResponse
BatchSearchChannelsEntry
BatchSearchChannelsRequest
Batched form of searchChannels. The map key of requests can be an arbitrary string identifier. It will be returned in the response as part of BatchedLocator.
BatchSearchChannelsResponse
BatchedChannelEntry
A channel (by name) found in one or more locators across the batch. locatorMetadata has one entry per locator the channel exists in.
BatchedLocator
A Locator annotated with the set of request ids whose batched-request scope expanded to it.
BatchedLocatorChannelMetadata
Per-locator channel metadata for batched responses. Same shape as LocatorChannelMetadata but with the locator wrapped to carry request-id provenance.
BatchedLocatorWithDelimiter
ChannelEntry
A channel (by name) found in one or more locators of the frame. locatorMetadata has one entry per locator the channel exists in; locators not represented here are ones where the channel does not exist.
GetLocatorDelimitersRequest
Returns the expanded locators of a frame plus per-locator delimiter (if that locator’s data source has an indexed prefix tree).
GetLocatorDelimitersResponse
ListChannelChildrenRequest
Lazy one-level expansion of the frame’s channel namespace under parent. For the root, pass an empty list.
ListChannelChildrenResponse
Locator
One expanded leaf of the data frame. Semantic fields (assetRid, runRid, dataScope) carry the branch context from frame expansion.
LocatorChannelMetadata
Metadata for a channel as it appears at one specific locator. Channels can have different metadata (seriesId, dataType, unit) across locators, so callers should treat each entry independently.
LocatorWithDelimiter
PrefixEntry
A prefix node collapsed across locators. presentAtLocators lists the locators where this prefix exists.
SearchChannelsRequest
SearchChannelsResponse

Enums§

ChannelChildEntry
ChannelSearchDataFrame
ChannelSearchQuery