Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.experimental.ingestion_rules.operations

Module Contents

CreateIngestionRuleRequest

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

Bases: pydantic.BaseModel

Request payload to create an ingestion rule.

Parameters

data Any

Attributes

CreateIngestionRuleRequest.auto_ingest

auto_ingest bool = True #

CreateIngestionRuleRequest.description

description str | None = None #

CreateIngestionRuleRequest.exclude_patterns

exclude_patterns list[str] = None #

CreateIngestionRuleRequest.include_patterns

include_patterns list[str] #

CreateIngestionRuleRequest.invocation

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.

CreateIngestionRuleRequest.name

name str #

IngestFilesRequest

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

Bases: pydantic.BaseModel

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

Parameters

data Any

Attributes

IngestFilesRequest.file_ids

file_ids list[str] = None #

IngestFilesResponse

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

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”

[Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes

IngestFilesResponse.__class_vars__

__class_vars__ #

The names of the class variables defined on the model.

IngestFilesResponse.__private_attributes__

__private_attributes__ #

Metadata about the private attributes of the model.

IngestFilesResponse.__signature__

__signature__ #

The synthesized __init__ [Signature][inspect.Signature] of the model.

IngestFilesResponse.__pydantic_complete__

__pydantic_complete__ #

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

IngestFilesResponse.__pydantic_core_schema__

__pydantic_core_schema__ #

The core schema of the model.

IngestFilesResponse.__pydantic_custom_init__

__pydantic_custom_init__ #

Whether the model has a custom __init__ function.

IngestFilesResponse.__pydantic_decorators__

__pydantic_decorators__ #

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

IngestFilesResponse.__pydantic_generic_metadata__

__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.

IngestFilesResponse.__pydantic_parent_namespace__

__pydantic_parent_namespace__ #

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

IngestFilesResponse.__pydantic_post_init__

__pydantic_post_init__ #

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

IngestFilesResponse.__pydantic_root_model__

__pydantic_root_model__ #

Whether the model is a [RootModel][pydantic.root_model.RootModel].

IngestFilesResponse.__pydantic_serializer__

__pydantic_serializer__ #

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

IngestFilesResponse.__pydantic_validator__

__pydantic_validator__ #

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

IngestFilesResponse.__pydantic_fields__

__pydantic_fields__ #

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

IngestFilesResponse.__pydantic_computed_fields__

__pydantic_computed_fields__ #

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

IngestFilesResponse.__pydantic_extra__

__pydantic_extra__ #

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

IngestFilesResponse.__pydantic_fields_set__

__pydantic_fields_set__ #

The names of fields explicitly set during instantiation.

IngestFilesResponse.__pydantic_private__

__pydantic_private__ #

Values of private attributes set on the model instance.

Parameters

data Any

Attributes

IngestFilesResponse.results

results list[roboto.experimental.ingestion_rules.record.IngestFileResult] #

One result per requested file, in request order.

LatestIngestionRunsRequest

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

Bases: pydantic.BaseModel

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

Parameters

data Any

Attributes

LatestIngestionRunsRequest.file_ids

file_ids list[str] = None #

LatestIngestionRunsResponse

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

Bases: pydantic.BaseModel

!!! abstract “Usage Documentation”

[Models](../concepts/models.md)

A base class for creating Pydantic models.

Attributes

LatestIngestionRunsResponse.__class_vars__

__class_vars__ #

The names of the class variables defined on the model.

LatestIngestionRunsResponse.__private_attributes__

__private_attributes__ #

Metadata about the private attributes of the model.

LatestIngestionRunsResponse.__signature__

__signature__ #

The synthesized __init__ [Signature][inspect.Signature] of the model.

LatestIngestionRunsResponse.__pydantic_complete__

__pydantic_complete__ #

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

LatestIngestionRunsResponse.__pydantic_core_schema__

__pydantic_core_schema__ #

The core schema of the model.

LatestIngestionRunsResponse.__pydantic_custom_init__

__pydantic_custom_init__ #

Whether the model has a custom __init__ function.

LatestIngestionRunsResponse.__pydantic_decorators__

__pydantic_decorators__ #

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

LatestIngestionRunsResponse.__pydantic_generic_metadata__

__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.

LatestIngestionRunsResponse.__pydantic_parent_namespace__

__pydantic_parent_namespace__ #

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

LatestIngestionRunsResponse.__pydantic_post_init__

__pydantic_post_init__ #

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

LatestIngestionRunsResponse.__pydantic_root_model__

__pydantic_root_model__ #

Whether the model is a [RootModel][pydantic.root_model.RootModel].

LatestIngestionRunsResponse.__pydantic_serializer__

__pydantic_serializer__ #

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

LatestIngestionRunsResponse.__pydantic_validator__

__pydantic_validator__ #

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

LatestIngestionRunsResponse.__pydantic_fields__

__pydantic_fields__ #

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

LatestIngestionRunsResponse.__pydantic_computed_fields__

__pydantic_computed_fields__ #

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

LatestIngestionRunsResponse.__pydantic_extra__

__pydantic_extra__ #

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

LatestIngestionRunsResponse.__pydantic_fields_set__

__pydantic_fields_set__ #

The names of fields explicitly set during instantiation.

LatestIngestionRunsResponse.__pydantic_private__

__pydantic_private__ #

Values of private attributes set on the model instance.

Parameters

data Any

Attributes

LatestIngestionRunsResponse.runs

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.

MAX_INGEST_FILES

roboto.experimental.ingestion_rules.operations.MAX_INGEST_FILES = 100#View Source

Most files one POST /v1/ingestion-rules/ingest takes.

MAX_MATCH_PATHS

roboto.experimental.ingestion_rules.operations.MAX_MATCH_PATHS = 200#View Source

The most paths one MatchIngestionRulesRequest may ask about.

MatchIngestionRulesRequest

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

Bases: pydantic.BaseModel

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

Parameters

data Any

Attributes

MatchIngestionRulesRequest.paths

paths list[str] = None #

File paths relative to their dataset, e.g. logs/run_1.mcap.

MatchIngestionRulesResponse

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

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

Attributes

MatchIngestionRulesResponse.matches

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

UpdateIngestionRuleRequest

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

Bases: pydantic.BaseModel

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

Parameters

data Any

Attributes

UpdateIngestionRuleRequest.auto_ingest

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.

UpdateIngestionRuleRequest.description

description str | None = None #

UpdateIngestionRuleRequest.exclude_patterns

exclude_patterns list[str] | None = None #

UpdateIngestionRuleRequest.include_patterns

include_patterns list[str] | None = None #

UpdateIngestionRuleRequest.invocation

invocation roboto.domain.triggers.ActionInvocationSpec | None = None #

Replaces the rule’s whole invocation when present.

UpdateIngestionRuleRequest.name

name str | None = None #

Was this page helpful?