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.core.RefCounted, org.elasticsearch.tasks.TaskAwareRequest, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public class GetCalendarEventsRequest extends org.elasticsearch.action.ActionRequest implements org.elasticsearch.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.xcontent.ToXContent

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

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

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

  • Field Summary

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

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • 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.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.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, toString

    Methods inherited from class org.elasticsearch.transport.TransportMessage

    decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

    createTask, getDescription, setParentTask

    Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

    isFragment

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