Class GetCalendarEventsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetCalendarEventsRequest.Builder>
co.elastic.clients.elasticsearch.ml.GetCalendarEventsRequest.Builder
- All Implemented Interfaces:
WithJson<GetCalendarEventsRequest.Builder>
,ObjectBuilder<GetCalendarEventsRequest>
- Enclosing class:
- GetCalendarEventsRequest
public static class GetCalendarEventsRequest.Builder
extends RequestBase.AbstractBuilder<GetCalendarEventsRequest.Builder>
implements ObjectBuilder<GetCalendarEventsRequest>
Builder for
GetCalendarEventsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGetCalendarEventsRequest
.calendarId
(String value) Required - A string that uniquely identifies a calendar.Specifies to get events with timestamps earlier than this time.Skips the specified number of events.Specifies to get events for a specific anomaly detection job identifier or job group.protected GetCalendarEventsRequest.Builder
self()
Specifies the maximum number of events to obtain.Specifies to get events with timestamps after this time.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetCalendarEventsRequest.Builder>
-
build
Builds aGetCalendarEventsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetCalendarEventsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-