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, org.elasticsearch.core.RefCounted, TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class GetCalendarEventsRequest extends ActionRequest implements org.elasticsearch.xcontent.ToXContentObject
Get the Scheduled Events for a Calendar

  • Field Details

    • START

      public static final org.elasticsearch.xcontent.ParseField START

    • END

      public static final org.elasticsearch.xcontent.ParseField END

    • PARSER

      public static final org.elasticsearch.xcontent.ConstructingObjectParser<GetCalendarEventsRequest,Void> PARSER

  • Constructor Details

    • GetCalendarEventsRequest

      public GetCalendarEventsRequest(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 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 String getStart()

    • setStart

      public void setStart(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 String getEnd()

    • setEnd

      public void setEnd(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 String getJobId()

    • setJobId

      public void setJobId(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 org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object