OpenSearch/docs/reference/ml/apis/eventresource.asciidoc

28 lines
798 B
Plaintext

[role="xpack"]
[testenv="platinum"]
[[ml-event-resource]]
=== Scheduled event resources
An events resource has the following properties:
`calendar_id`::
(string) An identifier for the calendar that contains the scheduled
event. This property is optional in the <<ml-post-calendar-event>>.
`description`::
(string) A description of the scheduled event.
`end_time`::
(date) The timestamp for the end of the scheduled event
in milliseconds since the epoch or ISO 8601 format.
`event_id`::
(string) An automatically-generated identifier for the scheduled event.
`start_time`::
(date) The timestamp for the beginning of the scheduled event
in milliseconds since the epoch or ISO 8601 format.
For more information, see
{xpack-ref}/ml-calendars.html[Calendars and Scheduled Events].