Package co.elastic.clients.elasticsearch.ml

Class GetCalendarEventsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetCalendarEventsRequest

public class GetCalendarEventsRequest
extends RequestBase

Get info about events in calendars.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetCalendarEventsRequest.Builder	Builder for GetCalendarEventsRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetCalendarEventsRequest,GetCalendarEventsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.get_calendar_events".

Method Summary

Modifier and Type	Method	Description
final String	calendarId()	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	of(Function<GetCalendarEventsRequest.Builder,ObjectBuilder<GetCalendarEventsRequest>> fn)
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_ENDPOINT

public static final Endpoint<GetCalendarEventsRequest,GetCalendarEventsResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.get_calendar_events".

Method Details

of

public static GetCalendarEventsRequest of(Function<GetCalendarEventsRequest.Builder,ObjectBuilder<GetCalendarEventsRequest>> fn)

calendarId

public final String 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

@Nullable
public final DateTime end()

Specifies to get events with timestamps earlier than this time.

API name: end

from

@Nullable
public final Integer from()

Skips the specified number of events.

API name: from

jobId

@Nullable
public final String 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

@Nullable
public final Integer size()

Specifies the maximum number of events to obtain.

API name: size

start

@Nullable
public final DateTime start()

Specifies to get events with timestamps after this time.

API name: start