Class GetCalendarEventsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetCalendarEventsRequest
Retrieves information about the scheduled events in calendars.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionEndpoint "ml.get_calendar_events
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
Required - A string that uniquely identifies a calendar.final DateTime
end()
Specifies to get events with timestamps earlier than this time.final Integer
from()
Skips the specified number of events.final String
jobId()
Specifies to get events for a specific anomaly detection job identifier or job group.static GetCalendarEventsRequest
final Integer
size()
Specifies the maximum number of events to obtain.final DateTime
start()
Specifies to get events with timestamps after this time.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetCalendarEventsRequest,GetCalendarEventsResponse, _ENDPOINTErrorResponse> Endpoint "ml.get_calendar_events
".
-
-
Method Details
-
of
public static GetCalendarEventsRequest of(Function<GetCalendarEventsRequest.Builder, ObjectBuilder<GetCalendarEventsRequest>> fn) -
calendarId
Required - A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using_all
or*
or by omitting the calendar identifier.API name:
calendar_id
-
end
Specifies to get events with timestamps earlier than this time.API name:
end
-
from
Skips the specified number of events.API name:
from
-
jobId
Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of_all
or*
.API name:
job_id
-
size
Specifies the maximum number of events to obtain.API name:
size
-
start
Specifies to get events with timestamps after this time.API name:
start
-