roboto.domain.actions.action_operations#
Module Contents#
- class roboto.domain.actions.action_operations.CreateActionRequest(/, **data)#
Bases:
pydantic.BaseModel
Request payload to create a new action.
Contains all the configuration needed to create a new action in the Roboto platform, including container settings, compute requirements, parameters, and metadata.
- Parameters:
data (Any)
- compute_requirements: roboto.domain.actions.action_record.ComputeRequirements | None = None#
CPU, memory, and other compute specifications.
- container_parameters: roboto.domain.actions.action_record.ContainerParameters | None = None#
Container image URI, entrypoint, and environment variables.
- description: str | None = None#
Detailed description of what the action does.
- inherits: roboto.domain.actions.action_record.ActionReference | None = None#
Reference to another action to inherit configuration from.
- metadata: dict[str, Any] = None#
Custom key-value metadata to associate with the action.
- name: str#
Unique name for the action within the organization.
- parameters: list[roboto.domain.actions.action_record.ActionParameter] = None#
List of parameters that can be provided at invocation time.
- requires_downloaded_inputs: bool | None = None#
Whether input files should be downloaded before execution.
- short_description: str | None = None#
Brief description (max 140 characters) for display purposes.
- tags: list[str] = None#
List of tags for categorizing and searching actions.
- timeout: int | None = None#
Maximum execution time in minutes before the action is terminated.
- uri: str | None = None#
Container image URI if not inheriting from another action.
- class roboto.domain.actions.action_operations.SetActionAccessibilityRequest(/, **data)#
Bases:
pydantic.BaseModel
Request payload to set action accessibility.
Used to change whether an action is private to the organization or published publicly in the Action Hub.
- Parameters:
data (Any)
- accessibility: roboto.domain.actions.action_record.Accessibility#
The new accessibility level (Organization or ActionHub).
- digest: str | None = None#
Specific version of Action. If not specified, the latest version’s accessibility will be updated.
- model_config#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class roboto.domain.actions.action_operations.UpdateActionRequest(/, **data)#
Bases:
pydantic.BaseModel
Request payload to update an action.
Contains the changes to apply to an existing action. Only specified fields will be updated; others remain unchanged. Uses NotSet sentinel values to distinguish between explicit None values and unspecified fields.
- Parameters:
data (Any)
- compute_requirements: roboto.domain.actions.action_record.ComputeRequirements | roboto.sentinels.NotSetType | None#
New compute requirements (CPU, memory).
- container_parameters: roboto.domain.actions.action_record.ContainerParameters | roboto.sentinels.NotSetType | None#
New container parameters (image, entrypoint, etc.).
- description: str | roboto.sentinels.NotSetType | None#
New detailed description.
- inherits: roboto.domain.actions.action_record.ActionReference | roboto.sentinels.NotSetType | None#
New action reference to inherit from.
- metadata_changeset: roboto.updates.MetadataChangeset | roboto.sentinels.NotSetType#
Changes to apply to metadata (add, remove, update keys).
- model_config#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- parameter_changeset: roboto.domain.actions.action_record.ActionParameterChangeset | roboto.sentinels.NotSetType#
Changes to apply to parameters (add, remove, update).
- requires_downloaded_inputs: bool | roboto.sentinels.NotSetType#
Whether to download input files before execution.
- short_description: str | roboto.sentinels.NotSetType | None#
New brief description (max 140 characters).
- timeout: int | roboto.sentinels.NotSetType | None#
New maximum execution time in minutes.
- uri: str | roboto.sentinels.NotSetType | None#
New container image URI.
- validate_uri(v)#