Trigger

Represents a trigger in the Flyte platform.

Attributes

Attribute	Type	Description
pb2	trigger_definition_pb2.Trigger	This attribute stores a trigger_definition_pb2.Trigger object, which is the protobuf representation of the trigger, used for interacting with the Flyte API.
details	`TriggerDetails	None` = None

---

Methods

---

create()

@classmethod
def create(
    trigger: flyte.Trigger,
    task_name: str,
    task_version: str | None
) - > [Trigger](trigger.md?sid=flyte_remote__trigger_trigger)

Create a new trigger in the Flyte platform.

Parameters

Name	Type	Description
trigger	flyte.Trigger	The flyte.Trigger object containing the trigger definition.
task_name	str	Optional name of the task to associate with the trigger.
task_version	`str	None`

Returns

Type	Description
[Trigger](trigger.md?sid=flyte_remote__trigger_trigger)

---

get()

@classmethod
def get(
    name: str,
    task_name: str
) - > TriggerDetails

Retrieve a trigger by its name and associated task name.

Parameters

Name	Type	Description
name	str	The name of the trigger to retrieve.
task_name	str	The name of the task associated with the trigger.

Returns

Type	Description
TriggerDetails

---

listall()

@classmethod
def listall(
    task_name: str | None,
    task_version: str | None,
    limit: int = 100
) - > AsyncIterator[[Trigger](trigger.md?sid=flyte_remote__trigger_trigger)]

List all triggers associated with a specific task or all tasks if no task name is provided.

Parameters

Name	Type	Description
task_name	`str	None`
task_version	`str	None`
limit	int = 100	The maximum number of triggers to return in a single page.

Returns

Type	Description
AsyncIterator[[Trigger](trigger.md?sid=flyte_remote__trigger_trigger)]

---

update()

@classmethod
def update(
    name: str,
    task_name: str,
    active: bool
)

Pause a trigger by its name and associated task name.

Parameters

Name	Type	Description
name	str	The name of the trigger to update.
task_name	str	The name of the task associated with the trigger.
active	bool	A boolean indicating whether the trigger should be active (True) or paused (False).

---

delete()

@classmethod
def delete(
    name: str,
    task_name: str,
    project: str | None,
    domain: str | None
)

Delete a trigger by its name.

Parameters

Name	Type	Description
name	str	The name of the trigger to delete.
task_name	str	The name of the task associated with the trigger.
project	`str	None`
domain	`str	None`

---

id()

@classmethod
def id() - > identifier_pb2.TriggerIdentifier

Get the unique identifier for the trigger.

Returns

Type	Description
identifier_pb2.TriggerIdentifier

---

name()

@classmethod
def name() - > str

Get the name of the trigger.

Returns

Type	Description
str

---

task_name()

@classmethod
def task_name() - > str

Get the name of the task associated with this trigger.

Returns

Type	Description
str

---

automation_spec()

@classmethod
def automation_spec() - > common_pb2.TriggerAutomationSpec

Get the automation specification for the trigger.

Returns

Type	Description
common_pb2.TriggerAutomationSpec

---

url()

@classmethod
def url() - > str

Get the console URL for viewing the trigger.

Returns

Type	Description
str

---

get_details()

@classmethod
def get_details() - > TriggerDetails

Get detailed information about this trigger.

Returns

Type	Description
TriggerDetails

---

is_active()

@classmethod
def is_active() - > bool

Check if the trigger is currently active.

Returns

Type	Description
bool

---