roboto.domain.actions.action_config
Module Contents
ActionConfig
Bases: pydantic.BaseModel
User-facing model for Action configuration used when creating or updating Actions.
This model defines the structure of the “action.json” file accepted by roboto actions create --from-file and templated for new Roboto Actions created by roboto actions init.
ActionConfig intentionally differs from roboto.domain.actions.action_record.ActionRecord by providing a simplified interface that: - Omits platform-managed fields (e.g., created, modified, org_id, digest) - Omits post-creation fields (e.g., published, accessibility) - Focuses on user-configurable options relevant at creation time
Structure:
- Required:
name - Optional: Most configuration options (compute requirements, parameters, metadata, etc.)
Parameters
data AnyAttributes
ActionConfig.compute_requirements
ActionConfig.container_parameters
ActionConfig.description
ActionConfig.docker_config
Configuration with which to build a Docker image for the Action.
ActionConfig.enforce_invariants()
Parameters
values dictReturn type
ActionConfig.from_file()
Load ActionConfig from a JSON file.
Parameters
path pathlib.Path to the JSON file containing action configuration
Returns
Parsed ActionConfig instance
Raises
FileNotFoundErrorIf the file doesn’t exist
pydantic.ValidationErrorIf the JSON is invalid or doesn’t match the schema
Attributes
ActionConfig.image_uri
URI to a non-local Docker image. Must already be pushed a registry accessible by the Roboto Platform.
ActionConfig.inherits
ActionConfig.metadata
ActionConfig.model_config
model_config #Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
ActionConfig.name
ActionConfig.parameters
ActionConfig.requires_downloaded_inputs
ActionConfig.short_description
ActionConfig.tags
ActionConfig.timeout
DockerImageConfig
Bases: pydantic.BaseModel
!!! abstract “Usage Documentation”
[Models](../concepts/models.md)
A base class for creating Pydantic models.
Attributes
DockerImageConfig.__class_vars__
__class_vars__ #The names of the class variables defined on the model.
DockerImageConfig.__private_attributes__
__private_attributes__ #Metadata about the private attributes of the model.
DockerImageConfig.__signature__
__signature__ #The synthesized __init__ [Signature][inspect.Signature] of the model.
DockerImageConfig.__pydantic_complete__
__pydantic_complete__ #Whether model building is completed, or if there are still undefined fields.
DockerImageConfig.__pydantic_custom_init__
__pydantic_custom_init__ #Whether the model has a custom __init__ function.
DockerImageConfig.__pydantic_decorators__
__pydantic_decorators__ #Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.
DockerImageConfig.__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.
DockerImageConfig.__pydantic_parent_namespace__
__pydantic_parent_namespace__ #Parent namespace of the model, used for automatic rebuilding of models.
DockerImageConfig.__pydantic_post_init__
__pydantic_post_init__ #The name of the post-init method for the model, if defined.
DockerImageConfig.__pydantic_root_model__
__pydantic_root_model__ #Whether the model is a [RootModel][pydantic.root_model.RootModel].
DockerImageConfig.__pydantic_serializer__
__pydantic_serializer__ #The pydantic-core SchemaSerializer used to dump instances of the model.
DockerImageConfig.__pydantic_validator__
__pydantic_validator__ #The pydantic-core SchemaValidator used to validate instances of the model.
DockerImageConfig.__pydantic_fields__
__pydantic_fields__ #A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.
DockerImageConfig.__pydantic_computed_fields__
__pydantic_computed_fields__ #A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.
DockerImageConfig.__pydantic_extra__
__pydantic_extra__ #A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.
DockerImageConfig.__pydantic_fields_set__
__pydantic_fields_set__ #The names of fields explicitly set during instantiation.
DockerImageConfig.__pydantic_private__
__pydantic_private__ #Values of private attributes set on the model instance.
Parameters
data Any