GetCalendarEventsRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetCalendarEventsRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetCalendarEventsRequest
extends RequestBase

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 Endpoint<GetCalendarEventsRequest,GetCalendarEventsResponse,ElasticsearchError> ENDPOINT
Endpoint "ml.get_calendar_events".

Constructor Summary

Constructors
Constructor	Description
`GetCalendarEventsRequest(GetCalendarEventsRequest.Builder builder)`
`GetCalendarEventsRequest(java.util.function.Function<GetCalendarEventsRequest.Builder,GetCalendarEventsRequest.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`calendarId()`	Required - The ID of the calendar containing the events
`java.lang.String`	`end()`	Get events before this time
`java.lang.Integer`	`from()`	Skips a number of events
`java.lang.String`	`jobId()`	Get events for the job.
`java.lang.Integer`	`size()`	Specifies a max number of events to get
`java.lang.String`	`start()`	Get events after this time

Methods inherited from class java.lang.Object

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

Field Details
- ENDPOINT
  
  public static final Endpoint<GetCalendarEventsRequest,GetCalendarEventsResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.get_calendar_events".
Constructor Details
- GetCalendarEventsRequest
  
  public GetCalendarEventsRequest(GetCalendarEventsRequest.Builder builder)
- GetCalendarEventsRequest
  
  public GetCalendarEventsRequest(java.util.function.Function<GetCalendarEventsRequest.Builder,GetCalendarEventsRequest.Builder> fn)
Method Details
- calendarId
  
  public java.lang.String calendarId()
  
  Required - The ID of the calendar containing the events
  API name: calendar_id
- jobId
  
  @Nullable public java.lang.String jobId()
  
  Get events for the job. When this option is used calendar_id must be '_all'
  API name: job_id
- end
  
  @Nullable public java.lang.String end()
  
  Get events before this time
  API name: end
- from
  
  @Nullable public java.lang.Integer from()
  
  Skips a number of events
  API name: from
- start
  
  @Nullable public java.lang.String start()
  
  Get events after this time
  API name: start
- size
  
  @Nullable public java.lang.Integer size()
  
  Specifies a max number of events to get
  API name: size