Package org.elasticsearch.client.ml

Class GetCalendarEventsRequest

java.lang.Object
org.elasticsearch.client.ml.GetCalendarEventsRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class GetCalendarEventsRequest extends Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Get the Scheduled Events for a Calendar

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static org.elasticsearch.common.xcontent.ParseField
    END
     
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<GetCalendarEventsRequest,​Void>
    PARSER
     
    static org.elasticsearch.common.xcontent.ParseField
    START
     

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

    Fields inherited from interface org.elasticsearch.client.Validatable

    EMPTY

  • Constructor Summary

    Constructors
    Constructor
    Description
    GetCalendarEventsRequest​(String calendarId)
    Create a new request to get the ScheduledEvents for the given calendarId.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals​(Object obj)
     
    String
    getCalendarId()
     
    String
    getEnd()
     
    String
    getJobId()
     
    PageParams
    getPageParams()
     
    String
    getStart()
     
    int
    hashCode()
     
    void
    setEnd​(String end)
    Specifies to get events with timestamps earlier than this time.
    void
    setJobId​(String jobId)
    The jobId for which to get the ScheduledEvents.
    void
    setPageParams​(PageParams pageParams)
    The paging parameters for the gathered ScheduledEvents
    void
    setStart​(String start)
    Specifies to get events with timestamps after this time.
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment

    Methods inherited from interface org.elasticsearch.client.Validatable

    validate

  • Field Details

    • START

      public static final org.elasticsearch.common.xcontent.ParseField START

    • END

      public static final org.elasticsearch.common.xcontent.ParseField END

    • PARSER

      public static final org.elasticsearch.common.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.

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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