Class Trigger
- Namespace
- GenerativeAI.Types
- Assembly
- GenerativeAI.dll
A trigger (/triggers): runs an agent interaction on a cron schedule.
public sealed class Trigger
- Inheritance
-
Trigger
- Inherited Members
- Extension Methods
Properties
ConsecutiveFailureCount
The current number of consecutive failures.
[JsonPropertyName("consecutive_failure_count")]
public int? ConsecutiveFailureCount { get; set; }
Property Value
- int?
CreateTime
Creation time (RFC 3339).
[JsonPropertyName("create_time")]
public string? CreateTime { get; set; }
Property Value
DisplayName
The display name.
[JsonPropertyName("display_name")]
public string? DisplayName { get; set; }
Property Value
EnvironmentId
The environment the runs use.
[JsonPropertyName("environment_id")]
public string? EnvironmentId { get; set; }
Property Value
ExecutionTimeoutSeconds
The timeout of each run, in seconds.
[JsonPropertyName("execution_timeout_seconds")]
public int? ExecutionTimeoutSeconds { get; set; }
Property Value
- int?
ExtensionData
Fields this SDK does not model yet.
[JsonExtensionData]
public Dictionary<string, JsonElement>? ExtensionData { get; set; }
Property Value
Id
The trigger ID.
[JsonPropertyName("id")]
public string? Id { get; set; }
Property Value
Interaction
The agent interaction created on each run.
[JsonPropertyName("interaction")]
public CreateInteractionRequest? Interaction { get; set; }
Property Value
LastPauseTime
Time the trigger was last paused (RFC 3339).
[JsonPropertyName("last_pause_time")]
public string? LastPauseTime { get; set; }
Property Value
LastResumeTime
Time the trigger was last resumed (RFC 3339).
[JsonPropertyName("last_resume_time")]
public string? LastResumeTime { get; set; }
Property Value
LastRunTime
Time of the last run (RFC 3339).
[JsonPropertyName("last_run_time")]
public string? LastRunTime { get; set; }
Property Value
MaxConsecutiveFailures
The number of consecutive failures after which the trigger is put in the error state.
[JsonPropertyName("max_consecutive_failures")]
public int? MaxConsecutiveFailures { get; set; }
Property Value
- int?
NextRunTime
Time of the next scheduled run (RFC 3339).
[JsonPropertyName("next_run_time")]
public string? NextRunTime { get; set; }
Property Value
PreviousInteractionId
The ID of the interaction created by the previous run.
[JsonPropertyName("previous_interaction_id")]
public string? PreviousInteractionId { get; set; }
Property Value
Schedule
The cron schedule (e.g. 0 9 * * 1-5).
[JsonPropertyName("schedule")]
public string? Schedule { get; set; }
Property Value
Status
The trigger status (see TriggerStatuses).
[JsonPropertyName("status")]
public string? Status { get; set; }
Property Value
TimeZone
The IANA time zone of Schedule (e.g. America/New_York).
[JsonPropertyName("time_zone")]
public string? TimeZone { get; set; }
Property Value
UpdateTime
Last update time (RFC 3339).
[JsonPropertyName("update_time")]
public string? UpdateTime { get; set; }