roboto.experimental#
Roboto APIs in active refinement.
Importing from roboto.experimental is your acknowledgement that the
imported API may change in shape, behavior, or semantics before it
stabilizes. Use these APIs for evaluation and feedback, not for
long-lived production code.
When an API graduates to stable, it moves to its canonical roboto.*
location, and from roboto.experimental import X becomes a forwarding
alias that emits a DeprecationWarning advising you to update the
import. The CHANGELOG records each graduation and the alias’s lifetime.
Submodules#
Package Contents#
- class roboto.experimental.RepresentationRecord(/, **data)#
Bases:
pydantic.BaseModelOne stored variant of a topic partition’s data, optionally narrowed to a subset of its fields.
A representation pairs a stored file with the data of a single topic partition.
field_idnarrows it to one field and the fields nested under it;Nonecovers every field in the partition.The same partition can have several representations that differ in
storage_format,content_format, andtransformations. A consumer picks the one whose attributes suit it: a viewer of image data, for example, may prefer a JPEG- or PNG-encoded variant over the untransformed original.- Parameters:
data (Any)
- content_format: str | None = None#
The format of the data inside the stored file. For image data, this may be the image encoding (e.g.
"jpeg","png") on a transformed variant.Nonewhen unspecified.
- created: datetime.datetime | None = None#
- created_by: str#
- field_id: str | None = None#
The field this representation is narrowed to, covering that field and the fields nested under it.
Nonewhen the representation covers every field in the partition.
- fs_node_id: str#
Identifier of the file backing this representation.
- model_config#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- modified: datetime.datetime | None = None#
- modified_by: str#
- org_id: str#
- representation_id: str#
- storage_format: roboto.domain.topics.RepresentationStorageFormat#
Container the representation data is stored in (e.g. MCAP, Parquet).
- topic_part_id: str#
Identifier of the topic partition this representation belongs to.
- transformations: list[str] = None#
The transformations applied to the source data to produce this variant, in the order applied. Empty on the untransformed original.
Each entry is a
"<kind>:<param>"string whose<kind>is aTransformationKindmember, e.g.["downsample:0.5", "encode:jpeg"].