roboto.domain.actions.action_config

Module Contents

class roboto.domain.actions.action_config.ActionConfig(/, **data)

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

See also

roboto.domain.actions.action_record.ActionRecord: The complete action representation roboto.domain.actions.action_record.ActionParameter: Parameter configuration roboto.domain.actions.action_record.ComputeRequirements: Compute resource configuration

Parameters:

data (Any)

compute_requirements: roboto.domain.actions.action_record.ComputeRequirements | None = None

container_parameters: roboto.domain.actions.action_record.ContainerParameters | None = None

description: str | None = None

docker_config: DockerImageConfig | None = None

Configuration with which to build a Docker image for the Action.

enforce_invariants(values)

Parameters:

values (dict)

Return type:

dict

image_uri: str | None = None

URI to a non-local Docker image. Must already be pushed a registry accessible by the Roboto Platform.

inherits: roboto.domain.actions.action_record.ActionReference | None = None

metadata: dict[str, Any] = None

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

parameters: list[roboto.domain.actions.action_record.ActionParameter] = None

requires_downloaded_inputs: bool | None = None

short_description: str | None = None

tags: list[str] = None

timeout: int | None = None

class roboto.domain.actions.action_config.DockerImageConfig(/, **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__

Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

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

build_args: dict[str, str] = None

context: pathlib.Path

dockerfile: pathlib.Path