Skip to content

Manage triggers

The CRUD methods read, update, and delete triggers. For creation, see Create a trigger and the examples in each trigger kind.

Read

Use the read methods to retrieve triggers from the backend or load them from a YAML descriptor.

get_trigger

Get a trigger entity from the backend.

Parameters:

Name Type Description Default
identifier str

Entity name or entity key (store://<project>/<entity_type>/<kind>/<(name>:)<uuid>).

required
project str

Project name. Required when identifier is an entity name.

None
entity_id str

Entity identifier. If omitted, the latest version is returned.

None

Returns:

Type Description
Trigger

Retrieved trigger entity.

Examples:

Get the latest trigger by name and project:

import digitalhub as dh

trigger = dh.get_trigger("daily-run", project="my-project")

Get a specific trigger version by key:

trigger = dh.get_trigger(
    "store://my-project/trigger/scheduler/daily-run:123e4567-e89b-42d3-a456-426614174000",
)
list_triggers

List trigger entities in a project.

Parameters:

Name Type Description Default
project str

Project name.

required
q str

Query string used to filter entities.

None
name str

Entity name used to filter results.

None
kind str

Entity kind used to filter results.

None
user str

User who created the entity.

None
state str

Entity state used to filter results.

None
created str

Creation date filter.

None
updated str

Update date filter.

None
versions str

Version filter. Defaults to the latest version.

None
task str

Task reference used to filter results.

None

Returns:

Type Description
list[Trigger]

Trigger entities matching the filters.

Examples:

List triggers in a project:

import digitalhub as dh

triggers = dh.list_triggers(project="my-project")
import_trigger

Import a trigger entity from a YAML file or entity key.

Parameters:

Name Type Description Default
file str

Path to a YAML file containing the entity descriptor. Provide either file or key.

None
key str

Entity key (store://<project>/<entity_type>/<kind>/<(name>:)<uuid>). Provide either file or key.

None
reset_id bool

Whether to generate a new entity identifier instead of preserving the identifier from the imported entity.

False
context str

Project name used for context resolution. If omitted, the project from the entity descriptor is used.

None

Returns:

Type Description
Trigger

Imported trigger entity.

Examples:

Import a trigger from a YAML file:

import digitalhub as dh

trigger = dh.import_trigger("my-trigger.yaml")

Update

Update a trigger after changing its mutable metadata.

update_trigger

Update a trigger entity in the backend.

Parameters:

Name Type Description Default
entity Trigger

Entity to update. The entity specification is immutable.

required

Returns:

Type Description
Trigger

Updated trigger entity.

Examples:

Update a trigger description:

import digitalhub as dh

trigger = dh.get_trigger("daily-run", project="my-project")
trigger.set_description("Updated trigger")
trigger = dh.update_trigger(trigger)

Delete

Delete one trigger version or all versions of a trigger.

delete_trigger

Delete a trigger entity from the backend.

Parameters:

Name Type Description Default
identifier str

Entity name or entity key (store://<project>/<entity_type>/<kind>/<(name>:)<uuid>).

required
project str

Project name. Required when identifier is an entity name.

None
entity_id str

Identifier of the version to delete. Required when identifier does not contain the version identifier.

None

Returns:

Type Description
dict

Response data from the backend.

Examples:

Delete one trigger version by key:

import digitalhub as dh

dh.delete_trigger(
    "store://my-project/trigger/scheduler/daily-run:123e4567-e89b-42d3-a456-426614174000",
)

Delete one trigger version by name and project:

dh.delete_trigger(
    "daily-run",
    project="my-project",
    entity_id="123e4567-e89b-42d3-a456-426614174000",
)