roboto.domain.actions.action_record

Module Contents

Accessibility

class roboto.domain.actions.action_record.Accessibility#

Bases: roboto.compat.StrEnum

Controls who can query for and invoke an action.

Accessibility levels determine the visibility and usability of actions within the Roboto platform. Actions can be private to an organization or published publicly in the Action Hub.

Future accessibility levels may include: “user” and/or “team”.

Attributes

Accessibility.ActionHub

ActionHub = 'action_hub' #

All users of Roboto can query for and invoke the action.

Accessibility.Organization

Organization = 'organization' #

All members of the organization owning the Action can query for and invoke the action.

ActionParameter

class roboto.domain.actions.action_record.ActionParameter(/, **data)#

Bases: pydantic.BaseModel

A parameter that can be provided to an Action at invocation time.

Action parameters allow customization of action behavior without modifying the action itself. Parameters can be required or optional, have default values, and include descriptions for documentation.

Parameters are validated when an action is invoked, ensuring that required parameters are provided and that values conform to expected types.

Parameters

data Any

Attributes

ActionParameter.default

default Any | None = None #

Default value applied for parameter if it is not required and no value is given at invocation.

Accepts any default value, but coerced to a string.

ActionParameter.description

description str | None = None #

Human-readable description of the parameter.

ActionParameter.model_config

model_config #

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

ActionParameter.name

name str #

Name of the parameter.

ActionParameter.required

required bool = False #

Whether this parameter is required at invocation time.

ActionParameter.validate_default()

classmethod validate_default(v)#

Parameters

v Optional[Any]

Return type

Optional[str]

ActionParameterChangeset

class roboto.domain.actions.action_record.ActionParameterChangeset(/, **data)#

Bases: pydantic.BaseModel

A changeset used to modify Action parameters.

Parameters

data Any

ActionParameterChangeset.Builder

class Builder#

ActionParameterChangeset.Builder.build()

build()#

Return type

ActionParameterChangeset

ActionParameterChangeset.Builder.put_parameter()

put_parameter(parameter)#

Parameters

parameter ActionParameter

Return type

ActionParameterChangeset

ActionParameterChangeset.Builder.remove_parameter()

remove_parameter(parameter_name)#

Parameters

parameter_name str

Return type

ActionParameterChangeset

ActionParameterChangeset.is_empty()

is_empty()#

Return type

bool

Attributes

ActionParameterChangeset.put_parameters

put_parameters list[ActionParameter] = None #

Parameters to add or update.

ActionParameterChangeset.remove_parameters

remove_parameters list[str] = None #

Names of parameters to remove.

ActionRecord

class roboto.domain.actions.action_record.ActionRecord(**kwargs)#

Bases: pydantic.BaseModel

A wire-transmissible representation of an action.

Attributes

ActionRecord.accessibility

accessibility Accessibility #

ActionRecord.compute_digest()

compute_digest()#

Return type

str

Attributes

ActionRecord.compute_requirements

compute_requirements ComputeRequirements | None = None #

ActionRecord.container_parameters

container_parameters ContainerParameters | None = None #

ActionRecord.created

created datetime.datetime #

ActionRecord.created_by

created_by str #

ActionRecord.description

description str | None = None #

ActionRecord.digest

digest str | None = None #

ActionRecord.inherits

inherits ActionReference | None = None #

ActionRecord.metadata

metadata dict[str, Any] = None #

ActionRecord.modified

modified datetime.datetime #

ActionRecord.modified_by

modified_by str #

ActionRecord.name

name str #

ActionRecord.org_id

org_id str #

ActionRecord.parameters

parameters list[ActionParameter] = None #

ActionRecord.published

published datetime.datetime | None = None #

Properties

ActionRecord.reference

reference ActionReference #

Return type: ActionReference

Attributes

ActionRecord.requires_downloaded_inputs

requires_downloaded_inputs bool | None = None #

ActionRecord.serialize_metadata()

serialize_metadata(metadata)#

Parameters

metadata dict[str, Any]

Return type

roboto.types.UserMetadata

Attributes

ActionRecord.short_description

short_description str | None = None #

ActionRecord.tags

tags list[str] = None #

ActionRecord.timeout

timeout int | None = None #

ActionRecord.uri

uri str | None = None #

ActionReference

class roboto.domain.actions.action_record.ActionReference(/, **data)#

Bases: pydantic.BaseModel

Qualified action reference.

Parameters

data Any

Attributes

ActionReference.digest

digest str | None = None #

ActionReference.name

name str #

ActionReference.owner

owner str | None = None #

ComputeRequirements

class roboto.domain.actions.action_record.ComputeRequirements(/, **data)#

Bases: pydantic.BaseModel

Compute requirements for an action invocation.

Parameters

data Any

Attributes

ComputeRequirements.gpu

gpu Literal[False] = False #

GPU configuration is not yet supported.

ComputeRequirements.memory

memory int = None #

Container memory in MiB. Set to 1024 MiB by default.

The possible values depend on the CPU units chosen, with as little as 512 MiB and as much as 122,800 MiB (120 GiB).

ComputeRequirements.model_config

model_config #

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

ComputeRequirements.storage

storage int = None #

Container storage in GiB. Set to 21 GiB by default.

The minimum allowed value is 21 GiB, and the maximum allowed value is 200 GiB (for premium-tier orgs).

ComputeRequirements.vCPU

vCPU int = 512 #

Container CPU units. Set to 512 by default.

1024 CPU units equal 1 vCPU.

Possible values: 256, 512, 1024, 2048, 4096, 8192, 16384.

ComputeRequirements.validate_storage_limit()

validate_storage_limit()#

ComputeRequirements.validate_vcpu_mem_combination()

validate_vcpu_mem_combination()#

Return type

ComputeRequirements

ContainerParameters

class roboto.domain.actions.action_record.ContainerParameters(/, **data)#

Bases: pydantic.BaseModel

Container parameters for an action invocation.

Parameters

data Any

Attributes

ContainerParameters.command

command list[str] | None = None #

ContainerParameters.entry_point

entry_point list[str] | None = None #

ContainerParameters.env_vars

env_vars dict[str, str] | None = None #

ContainerParameters.model_config

model_config #

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

ContainerParameters.workdir

workdir str | None = None #

ExecutorContainer

class roboto.domain.actions.action_record.ExecutorContainer(*args, **kwds)#

Bases: enum.Enum

Type of container running as part of an action invocation

Attributes

ExecutorContainer.Action

Action = 'action' #

ExecutorContainer.LogRouter

LogRouter = 'firelens_log_router' #

ExecutorContainer.Monitor

Monitor = 'monitor' #

ExecutorContainer.OutputHandler

OutputHandler = 'output_handler' #

ExecutorContainer.Setup

Setup = 'setup' #