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

roboto.domain.actions.trigger_operations

Module Contents

CreateTriggerRequest

class roboto.domain.actions.trigger_operations.CreateTriggerRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to create a new trigger.

Contains all the configuration needed to create a trigger that automatically invokes actions when specific conditions are met.

Parameters

data Any

Attributes

CreateTriggerRequest.action_digest

action_digest str | None = None #

Optional specific version digest of the action to invoke. If not provided, uses the latest version.

CreateTriggerRequest.action_name

action_name str #

Name of the action to invoke when the trigger fires.

CreateTriggerRequest.action_owner_id

action_owner_id str | None = None #

Organization ID that owns the target action. If not provided, searches in the caller’s organization.

CreateTriggerRequest.additional_inputs

additional_inputs list[str] | None = None #

Optional additional file patterns to include in action invocations beyond the required inputs.

CreateTriggerRequest.causes

List of events that can cause this trigger to be evaluated. If not provided, uses default causes.

CreateTriggerRequest.compute_requirement_overrides

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

Optional compute requirement overrides for action invocations.

CreateTriggerRequest.condition

condition roboto.query.ConditionType | None = None #

Optional condition that must be met for the trigger to fire.

Can filter based on metadata, file properties, etc.

CreateTriggerRequest.container_parameter_overrides

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

Optional container parameter overrides for action invocations.

CreateTriggerRequest.enabled

enabled bool = True #

Whether the trigger should be active immediately after creation.

CreateTriggerRequest.for_each

Granularity of execution - Dataset or DatasetFile.

CreateTriggerRequest.name

name str = None #

Unique name for the trigger (alphanumeric, hyphens, underscores only, max 256 characters).

CreateTriggerRequest.parameter_values

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

Parameter values to pass to the action when invoked.

CreateTriggerRequest.required_inputs

required_inputs list[str] #

List of file patterns that must be present for the trigger to fire. Uses glob patterns like ‘**/*.bag’.

CreateTriggerRequest.service_user_id

service_user_id str | None = None #

Optional service user ID for authentication.

CreateTriggerRequest.timeout

timeout int | None = None #

Optional timeout override for action invocations in minutes.

CreateTriggerRequest.validate_additional_inputs()

validate_additional_inputs(value)#View Source

Parameters

value Optional[list[str]]

Return type

Optional[list[str]]

CreateTriggerRequest.validate_required_inputs()

validate_required_inputs(value)#View Source

Parameters

value list[str]

Return type

list[str]

EvaluateTriggersRequest

class roboto.domain.actions.trigger_operations.EvaluateTriggersRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to manually evaluate specific triggers.

Used to force evaluation of triggers outside of their normal automatic evaluation cycle. This is typically used for testing or debugging trigger behavior.

Parameters

data Any

Attributes

EvaluateTriggersRequest.trigger_evaluation_ids

trigger_evaluation_ids collections.abc.Iterable[int] #

Collection of trigger evaluation IDs to process.

QueryTriggersRequest

class roboto.domain.actions.trigger_operations.QueryTriggersRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to query triggers with filters.

Used to search for triggers based on various criteria such as name, status, or other attributes.

Parameters

data Any

Attributes

QueryTriggersRequest.filters

filters dict[str, Any] = None #

Dictionary of filter criteria to apply to the trigger search.

QueryTriggersRequest.model_config

model_config #

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

TriggerEvaluationsSummaryResponse

class roboto.domain.actions.trigger_operations.TriggerEvaluationsSummaryResponse(/, **data)#View Source

Bases: pydantic.BaseModel

Response containing summary information about trigger evaluations.

Provides high-level statistics about trigger evaluation status, useful for monitoring and debugging trigger performance.

Parameters

data Any

Attributes

TriggerEvaluationsSummaryResponse.count_pending

count_pending int #

Number of trigger evaluations currently pending.

TriggerEvaluationsSummaryResponse.last_evaluation_start

last_evaluation_start datetime.datetime | None #

Timestamp of the most recent evaluation start, if any evaluations have occurred.

UpdateTriggerRequest

class roboto.domain.actions.trigger_operations.UpdateTriggerRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to update an existing trigger.

Contains the changes to apply to a trigger. 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

UpdateTriggerRequest.action_digest

action_digest str | roboto.sentinels.NotSetType | None #

New specific version digest of the action.

UpdateTriggerRequest.action_name

action_name str | roboto.sentinels.NotSetType #

New action name to invoke.

UpdateTriggerRequest.action_owner_id

action_owner_id str | roboto.sentinels.NotSetType #

New organization ID that owns the target action.

UpdateTriggerRequest.additional_inputs

additional_inputs list[str] | roboto.sentinels.NotSetType | None #

New additional file patterns to include.

UpdateTriggerRequest.causes

New list of events that can cause trigger evaluation.

UpdateTriggerRequest.compute_requirement_overrides

New compute requirement overrides.

UpdateTriggerRequest.condition

New condition that must be met for trigger to fire.

UpdateTriggerRequest.container_parameter_overrides

New container parameter overrides.

UpdateTriggerRequest.enabled

New enabled status for the trigger.

UpdateTriggerRequest.for_each

New execution granularity (Dataset or DatasetFile).

UpdateTriggerRequest.model_config

model_config #

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

UpdateTriggerRequest.parameter_values

parameter_values dict[str, Any] | roboto.sentinels.NotSetType | None #

New parameter values to pass to the action.

UpdateTriggerRequest.required_inputs

required_inputs list[str] | roboto.sentinels.NotSetType #

New list of required file patterns.

UpdateTriggerRequest.timeout

timeout int | roboto.sentinels.NotSetType | None #

New timeout override for action invocations.

Was this page helpful?