roboto.domain.actions.invocation_operations

Module Contents

class roboto.domain.actions.invocation_operations.CancelActiveInvocationsRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to bulk cancel all active invocations within an organization.

This operation cancels multiple invocations in a single request, but only affects invocations that are in non-terminal states (Queued, Running, etc.). The operation is limited in the number of invocations it will attempt to cancel in a single call for performance reasons.

For large numbers of active invocations, continue calling this operation until the count_remaining returned in the response is 0.

Parameters:

data (Any)

created_before: datetime.datetime | None = None

Only cancel invocations created before this timestamp.

If not provided, cancels all active invocations regardless of age.

class roboto.domain.actions.invocation_operations.CancelActiveInvocationsResponse(/, **data)

Bases: pydantic.BaseModel

Response payload from bulk cancellation of active invocations.

Contains the results of a bulk cancellation operation, including counts of successful and failed cancellations, and the number of invocations remaining to be cancelled.

Parameters:

data (Any)

count_remaining: int

Number of invocations that are still active.

failure_count: int

Number of invocations that failed to cancel.

success_count: int

Number of invocations successfully cancelled.

class roboto.domain.actions.invocation_operations.CreateInvocationRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to create a new action invocation.

Contains all the configuration needed to invoke an action, including input data specifications, parameter values, and execution overrides.

Parameters:

data (Any)

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

Optional overrides for CPU, memory, and other compute specifications.

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

Optional overrides for container image, entrypoint, and environment variables.

data_source_id: str

ID of the data source providing input data.

data_source_type: roboto.domain.actions.invocation_record.InvocationDataSourceType

Type of the data source (e.g., Dataset).

idempotency_id: str | None = None

Optional unique ID to ensure the invocation runs exactly once.

input_data: list[str]

List of file patterns for input data selection.

invocation_source: roboto.domain.actions.invocation_record.InvocationSource

Source of the invocation (Manual, Trigger, etc.).

invocation_source_id: str | None = None

Optional ID of the entity that initiated the invocation.

parameter_values: dict[str, Any] | None = None

Optional parameter values to pass to the action.

rich_input_data: roboto.domain.actions.invocation_record.InvocationInput | None = None

Optional rich input data specification that supersedes the simple input_data patterns.

timeout: int | None = None

Optional timeout override in minutes.

upload_destination: roboto.domain.actions.invocation_record.InvocationUploadDestination | None = None

Optional destination for output files.

class roboto.domain.actions.invocation_operations.SetContainerInfoRequest(/, **data)

Bases: pydantic.BaseModel

Request to set container information for an invocation.

Used internally by the Roboto platform to record container details after the action image has been pulled and inspected.

Note

This is typically called from the monitor process and is not intended for direct use by SDK users.

Parameters:

data (Any)

image_digest: str

The digest of the container image that was pulled.

class roboto.domain.actions.invocation_operations.SetLogsLocationRequest(/, **data)

Bases: pydantic.BaseModel

Request to set the location where invocation logs are stored.

Used internally by the Roboto platform to record where log files are saved for later retrieval.

Note

This is typically called from the invocation-scheduling-service and is not intended for direct use by SDK users.

Parameters:

data (Any)

bucket: str

S3 bucket name where logs are stored.

prefix: str

S3 key prefix for the log files.

class roboto.domain.actions.invocation_operations.UpdateInvocationStatus(/, **data)

Bases: pydantic.BaseModel

Request payload to update an invocation’s status.

Used to record status changes during invocation execution, such as transitioning from Queued to Running to Completed.

Parameters:

data (Any)

detail: str

Additional detail about the status change.

status: roboto.domain.actions.invocation_record.InvocationStatus

The new status for the invocation.