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

roboto.domain.actions.action_operations

Module Contents

CreateActionRequest

class roboto.domain.actions.action_operations.CreateActionRequest(/, **data)#View Source

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

Attributes

CreateActionRequest.compute_requirements

CPU, memory, and other compute specifications.

CreateActionRequest.container_parameters

Container image URI, entrypoint, and environment variables.

CreateActionRequest.description

description str | None = None #

Detailed description of what the action does.

CreateActionRequest.inherits

Reference to another action to inherit configuration from.

CreateActionRequest.metadata

metadata dict[str, Any] = None #

Custom key-value metadata to associate with the action.

CreateActionRequest.name

name str #

Unique name for the action within the organization.

CreateActionRequest.parameters

List of parameters that can be provided at invocation time.

CreateActionRequest.requires_downloaded_inputs

requires_downloaded_inputs bool | None = None #

Whether input files should be downloaded before execution.

CreateActionRequest.short_description

short_description str | None = None #

Brief description (max 140 characters) for display purposes.

CreateActionRequest.tags

tags list[str] = None #

List of tags for categorizing and searching actions.

CreateActionRequest.timeout

timeout int | None = None #

Maximum execution time in minutes before the action is terminated.

CreateActionRequest.uri

uri str | None = None #

Container image URI if not inheriting from another action.

SetActionAccessibilityRequest

class roboto.domain.actions.action_operations.SetActionAccessibilityRequest(/, **data)#View Source

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

Attributes

SetActionAccessibilityRequest.accessibility

The new accessibility level (Organization or ActionHub).

SetActionAccessibilityRequest.digest

digest str | None = None #

Specific version of Action. If not specified, the latest version’s accessibility will be updated.

SetActionAccessibilityRequest.model_config

model_config #

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

UpdateActionRequest

class roboto.domain.actions.action_operations.UpdateActionRequest(/, **data)#View Source

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

Attributes

UpdateActionRequest.compute_requirements

New compute requirements (CPU, memory).

UpdateActionRequest.container_parameters

New container parameters (image, entrypoint, etc.).

UpdateActionRequest.description

description str | roboto.sentinels.NotSetType | None #

New detailed description.

UpdateActionRequest.inherits

New action reference to inherit from.

UpdateActionRequest.metadata_changeset

Changes to apply to metadata (add, remove, update keys).

UpdateActionRequest.model_config

model_config #

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

UpdateActionRequest.parameter_changeset

Changes to apply to parameters (add, remove, update).

UpdateActionRequest.requires_downloaded_inputs

requires_downloaded_inputs bool | roboto.sentinels.NotSetType #

Whether to download input files before execution.

UpdateActionRequest.short_description

short_description str | roboto.sentinels.NotSetType | None #

New brief description (max 140 characters).

UpdateActionRequest.timeout

timeout int | roboto.sentinels.NotSetType | None #

New maximum execution time in minutes.

UpdateActionRequest.uri

New container image URI.

UpdateActionRequest.validate_uri()

validate_uri(v)#View Source

Was this page helpful?