Type Alias Trigger

Trigger: {
    consecutive_failure_count?: number;
    create_time?: string;
    display_name?: string;
    environment_id?: string;
    execution_timeout_seconds?: number;
    id: string;
    interaction: Interaction;
    last_pause_time?: string;
    last_resume_time?: string;
    last_run_time?: string;
    max_consecutive_failures?: number;
    next_run_time?: string;
    previous_interaction_id?: string;
    schedule: string;
    status?: TriggerStatus;
    time_zone: string;
    update_time?: string;
}

A trigger configuration that is scheduled to run an agent.

Type declaration

  • Optionalconsecutive_failure_count?: number

    Output only. The number of consecutive failures that have occurred

    Remarks

    since the last successful execution.

  • Optionalcreate_time?: string

    Output only. The time when the trigger was created.

  • Optionaldisplay_name?: string

    Optional. The display name of the trigger.

  • Optionalenvironment_id?: string

    Optional. The environment ID for the trigger execution.

  • Optionalexecution_timeout_seconds?: number

    Optional. The execution timeout for the triggered interaction.

  • id: string

    Required. Output only. Identifier. The ID of the trigger.

  • interaction: Interaction

    The Interaction resource.

  • Optionallast_pause_time?: string

    Output only. The time when the trigger was last paused.

  • Optionallast_resume_time?: string

    Output only. The time when the trigger was last resumed.

  • Optionallast_run_time?: string

    Output only. The time when the trigger was last run.

  • Optionalmax_consecutive_failures?: number

    Optional. The maximum number of consecutive failures allowed before

    Remarks

    the trigger is automatically paused (status becomes ERROR).

  • Optionalnext_run_time?: string

    Output only. The time when the trigger is scheduled to run next.

  • Optionalprevious_interaction_id?: string

    Output only. The ID of the last interaction created by this trigger.

  • schedule: string

    Required. The cron schedule on which the trigger should run.

    Remarks

    Standard cron format.

  • Optionalstatus?: TriggerStatus

    Output only. The current status of the trigger.

  • time_zone: string

    Required. Time zone in which the schedule should be interpreted.

  • Optionalupdate_time?: string

    Output only. The time when the trigger was last updated.

Settings