Package co.elastic.clients.elasticsearch.ml

Class GetCalendarEventsRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.ml.GetCalendarEventsRequest.Builder
All Implemented Interfaces:
ObjectBuilder<GetCalendarEventsRequest>
Enclosing class:
GetCalendarEventsRequest
public static class GetCalendarEventsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetCalendarEventsRequest>
Builder for GetCalendarEventsRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • calendarId

      public final GetCalendarEventsRequest.Builder calendarId​(java.lang.String value)
      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

      public final GetCalendarEventsRequest.Builder end​(@Nullable java.lang.String value)
      Specifies to get events with timestamps earlier than this time.

      API name: end

    • from

      public final GetCalendarEventsRequest.Builder from​(@Nullable java.lang.Integer value)
      Skips the specified number of events.

      API name: from

    • jobId

      public final GetCalendarEventsRequest.Builder jobId​(@Nullable java.lang.String value)
      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

      public final GetCalendarEventsRequest.Builder size​(@Nullable java.lang.Integer value)
      Specifies the maximum number of events to obtain.

      API name: size

    • start

      public final GetCalendarEventsRequest.Builder start​(@Nullable java.lang.String value)
      Specifies to get events with timestamps after this time.

      API name: start

    • build

      public GetCalendarEventsRequest build()
      Builds a GetCalendarEventsRequest.
      Specified by:
      build in interface ObjectBuilder<GetCalendarEventsRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.