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:
org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.tasks.TaskAwareRequest
public class GetCalendarEventsRequest
extends org.elasticsearch.action.ActionRequest
implements org.elasticsearch.common.xcontent.ToXContentObject
Get the Scheduled Events for a Calendar

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

    org.elasticsearch.transport.TransportRequest.Empty

    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

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

  • Field Summary

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

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

    EMPTY_PARAMS

  • Constructor Summary

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

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object obj)  
    java.lang.String getCalendarId()  
    java.lang.String getEnd()  
    java.lang.String getJobId()  
    PageParams getPageParams()  
    java.lang.String getStart()  
    int hashCode()  
    void setEnd​(java.lang.String end)
    Specifies to get events with timestamps earlier than this time.
    void setJobId​(java.lang.String jobId)
    The jobId for which to get the ScheduledEvents.
    void setPageParams​(PageParams pageParams)
    The paging parameters for the gathered ScheduledEvents
    void setStart​(java.lang.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)  
    org.elasticsearch.action.ActionRequestValidationException validate()  

    Methods inherited from class org.elasticsearch.action.ActionRequest

    getShouldStoreResult, writeTo

    Methods inherited from class org.elasticsearch.transport.TransportRequest

    getParentTask, setParentTask

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    remoteAddress, remoteAddress

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

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

    isFragment

  • Field Details

    • START

      public static final org.elasticsearch.common.ParseField START

    • END

      public static final org.elasticsearch.common.ParseField END

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<GetCalendarEventsRequest,​java.lang.Void> PARSER

  • 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 org.elasticsearch.action.ActionRequestValidationException validate()
      Specified by:
      validate in class org.elasticsearch.action.ActionRequest

    • toXContent

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