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

Nested Class Summary

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

TransportRequest.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	END
static ConstructingObjectParser<GetCalendarEventsRequest,Void>	PARSER
static ParseField	START

Fields inherited from interface org.elasticsearch.common.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.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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 Detail

START

public static final ParseField START

END

public static final ParseField END

PARSER

public static final ConstructingObjectParser<GetCalendarEventsRequest,Void> PARSER

Constructor Detail

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 Detail

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 XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object