Package org.elasticsearch.client.ml

Class GetCalendarEventsRequest

java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.TransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.client.ml.GetCalendarEventsRequest
All Implemented Interfaces:
Writeable, ToXContent, ToXContentObject, TaskAwareRequest
public class GetCalendarEventsRequest
extends ActionRequest
implements ToXContentObject
Get the Scheduled Events for a Calendar

  • Field Details

  • Constructor Details

    • GetCalendarEventsRequest

      public GetCalendarEventsRequest​(java.lang.String calendarId)
      Create a new request to get the ScheduledEvents for the given calendarId.
      Parameters:
      calendarId - The ID of the calendar. Can be `_all` to get ALL ScheduledEvents for all calendars.

  • Method Details

    • getCalendarId

      public java.lang.String getCalendarId()

    • getPageParams

      public PageParams getPageParams()

    • setPageParams

      public void setPageParams​(PageParams pageParams)
      The paging parameters for the gathered ScheduledEvents
      Parameters:
      pageParams - The desired paging params

    • getStart

      public java.lang.String getStart()

    • setStart

      public void setStart​(java.lang.String start)
      Specifies to get events with timestamps after this time.
      Parameters:
      start - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getEnd

      public java.lang.String getEnd()

    • setEnd

      public void setEnd​(java.lang.String end)
      Specifies to get events with timestamps earlier than this time.
      Parameters:
      end - String representation of a timestamp; may be an epoch seconds, epoch millis or an ISO string

    • getJobId

      public java.lang.String getJobId()

    • setJobId

      public void setJobId​(java.lang.String jobId)
      The jobId for which to get the ScheduledEvents. When this option is used calendarId must be `_all`
      Parameters:
      jobId - The job for which to get the events.

    • validate

      public ActionRequestValidationException validate()
      Specified by:
      validate in class ActionRequest

    • toXContent

      public XContentBuilder toXContent​(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      java.io.IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object