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

roboto.domain.actions.invocation_operations

Module Contents

CancelActiveInvocationsRequest

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

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 has_more returned in the response is False.

Parameters

data Any

Attributes

CancelActiveInvocationsRequest.created_before

created_before datetime.datetime | None = None #

Only cancel invocations created before this timestamp.

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

CancelActiveInvocationsResponse

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

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 whether there are more active invocations to cancel.

Parameters

data Any

Attributes

CancelActiveInvocationsResponse.failure_count

failure_count int #

Number of invocations that failed to cancel.

CancelActiveInvocationsResponse.has_more

has_more bool #

Whether there are more active invocations to cancel.

CancelActiveInvocationsResponse.success_count

success_count int #

Number of invocations successfully cancelled.

CreateInvocationRequest

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

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

Attributes

CreateInvocationRequest.compute_requirement_overrides

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

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

CreateInvocationRequest.container_parameter_overrides

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

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

CreateInvocationRequest.data_source_id

data_source_id str #

ID of the data source providing input data.

CreateInvocationRequest.data_source_type

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

CreateInvocationRequest.idempotency_id

idempotency_id str | None = None #

Optional unique ID to ensure the invocation runs exactly once.

CreateInvocationRequest.input_data

input_data list[str] #

List of file patterns for input data selection.

CreateInvocationRequest.invocation_source

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

CreateInvocationRequest.invocation_source_id

invocation_source_id str | None = None #

Optional ID of the entity that initiated the invocation.

CreateInvocationRequest.parameter_values

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

Optional parameter values to pass to the action.

CreateInvocationRequest.rich_input_data

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

CreateInvocationRequest.timeout

timeout int | None = None #

Optional timeout override in minutes.

CreateInvocationRequest.upload_destination

Optional destination for output files.

SetContainerInfoRequest

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

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.

Parameters

data Any

Attributes

SetContainerInfoRequest.image_digest

image_digest str #

The digest of the container image that was pulled.

SetLogsLocationRequest

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

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.

Parameters

data Any

Attributes

SetLogsLocationRequest.bucket

bucket str #

S3 bucket name where logs are stored.

SetLogsLocationRequest.prefix

prefix str #

S3 key prefix for the log files.

UpdateInvocationStatus

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

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

Attributes

UpdateInvocationStatus.detail

detail str #

Additional detail about the status change.

UpdateInvocationStatus.status

The new status for the invocation.

Was this page helpful?