roboto.experimental.ingestion_rules.operations#

Module Contents#

class roboto.experimental.ingestion_rules.operations.CreateIngestionRuleRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to create an ingestion rule.

Parameters:: data (Any)

auto_ingest: bool = True#

description: str | None = None#

exclude_patterns: list[str]#

include_patterns: list[str]#

invocation: roboto.domain.triggers.ActionInvocationSpec | None = None#: How each matching upload is ingested. Its invocation_input selects only inputs beyond the uploaded file, which the rule’s trigger always passes first. Required when auto_ingest is on.

name: str#

class roboto.experimental.ingestion_rules.operations.IngestFilesRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to ingest existing files now with the org’s rules that match them.

Parameters:: data (Any)

file_ids: list[str]#

class roboto.experimental.ingestion_rules.operations.IngestFilesResponse(/, **data)#

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

Parameters:: data (Any)

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

results: list[roboto.experimental.ingestion_rules.record.IngestFileResult]#: One result per requested file, in request order.

class roboto.experimental.ingestion_rules.operations.LatestIngestionRunsRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to look up the latest ingestion run on each of some files.

Parameters:: data (Any)

file_ids: list[str]#

class roboto.experimental.ingestion_rules.operations.LatestIngestionRunsResponse(/, **data)#

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”: [Models](../concepts/models.md)

A base class for creating Pydantic models.

Parameters:: data (Any)

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: A dictionary containing metadata about generic Pydantic models. The origin and args items map to the [__origin__][genericalias.__origin__] and [__args__][genericalias.__args__] attributes of [generic aliases][types-genericalias], and the parameter item maps to the __parameter__ attribute of generic classes.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

runs: dict[str, roboto.experimental.ingestion_runs.IngestionRun]#: The latest run per file id. A file whose current upload no rule’s trigger has run on, or that the caller may not view, is absent.

roboto.experimental.ingestion_rules.operations.MAX_INGEST_FILES = 100#: Most files one POST /v1/ingestion-rules/ingest takes.

roboto.experimental.ingestion_rules.operations.MAX_MATCH_PATHS = 200#: The most paths one MatchIngestionRulesRequest may ask about.

class roboto.experimental.ingestion_rules.operations.MatchIngestionRulesRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to ask which of an org’s ingestion rules match each of some file paths.

Parameters:: data (Any)

paths: list[str]#: File paths relative to their dataset, e.g. logs/run_1.mcap.

class roboto.experimental.ingestion_rules.operations.MatchIngestionRulesResponse(/, **data)#

Bases: pydantic.BaseModel

The rules matching each requested path, oldest rule first. A path no rule matches maps to an empty list.

Parameters:: data (Any)

matches: dict[str, list[roboto.experimental.ingestion_rules.record.IngestionRuleRecord]]#

class roboto.experimental.ingestion_rules.operations.UpdateIngestionRuleRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to change an ingestion rule. Only the fields present in the payload change.

Parameters:: data (Any)

auto_ingest: bool | None = None#: Turning this on enables the rule’s trigger, creating it if the rule had none; turning it off disables it.

description: str | None = None#

exclude_patterns: list[str] | None = None#

include_patterns: list[str] | None = None#

invocation: roboto.domain.triggers.ActionInvocationSpec | None = None#: Replaces the rule’s whole invocation when present.

name: str | None = None#