UnsavedScheduledSearch
UnsavedScheduledSearch
is a datatype for an unsaved scheduled search.
Table: UnsavedScheduledSearch
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
Table last updated: Apr 3, 2025 | |||||
actions | [Action ] | yes | Long-Term | A list of IDs for actions to fire on query result. See Action . | |
backfillLimit | integer | yes | Deprecated | User-defined limit, which caps the number of missed searches to backfill (e.g., in the event of a shutdown). This option is deprecated and will be removed at the earliest in version 1.231. Use instead backfillLimitV2 . | |
backfillLimitV2 | integer | Long-Term | User-defined limit, which caps the number of missed searches to backfill when queryTimestampType is EventTimestamp . | ||
description | string | Long-Term | A description of the scheduled search. | ||
enabled | boolean | yes | Long-Term | Whether the scheduled search is enabled. | |
end | string | yes | Deprecated | End of the relative time interval for the query. This field is deprecated. It will be removed at the earliest in version 1.231. | |
labels | [string] | yes | Long-Term | Labels attached to the scheduled search. | |
maxWaitTimeSeconds | long | Long-Term | The maximum wait time in seconds when queryTimestampType is IngestTimestamp . | ||
name | string | yes | Long-Term | The name of the scheduled search. | |
queryString | string | yes | Long-Term | The LogScale query to execute. | |
queryTimestampType | QueryTimestampType | yes | Long-Term | The timestamp type to use for the query. Running on @ingesttimestamp is only available with feature flag ScheduledSearchIngestTimestamp . See QueryTimestampType . | |
schedule | string | yes | Long-Term | The cron pattern describing the schedule on which to execute the query. | |
searchIntervalOffsetSeconds | long | Long-Term | The search interval offset in seconds when queryTimestampType is EventTimestamp . | ||
searchIntervalSeconds | long | yes | Long-Term | The search interval in seconds. | |
start | string | yes | Deprecated | Start of the relative time interval for the query. This field is deprecated. It will be removed at the earliest in version 1.231. | |
timeZone | string | yes | Long-Term | The time zone of the schedule. Currently, this field supports only UTC offsets (e.g., 'UTC', 'UTC-01' or 'UTC+12:45'). |