Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.calendars

Class Calendar

java.lang.Object

org.elasticsearch.xpack.core.ml.calendars.Calendar

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class Calendar
extends Object
implements ToXContentObject, Writeable

A simple calendar object for scheduled (special) events. The calendar consists of a name an a list of job Ids or job groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Calendar.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.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 final String	CALENDAR_TYPE
static final ParseField	DESCRIPTION
static final ParseField	ID
static final ParseField	JOB_IDS
static final ObjectParser<Calendar.Builder,Void>	LENIENT_PARSER
static final ParseField	RESULTS_FIELD
static final ObjectParser<Calendar.Builder,Void>	STRICT_PARSER
static final ParseField	TYPE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Calendar(String id, List<String> jobIds, String description)	jobIds can be a mix of job groups and job Ids
Calendar(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static Calendar.Builder	builder()
String	documentId()
static String	documentId(String calendarId)
boolean	equals(Object obj)
String	getDescription()
String	getId()
List<String>	getJobIds()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

CALENDAR_TYPE

public static final String CALENDAR_TYPE

See Also:

• Constant Field Values

TYPE

public static final ParseField TYPE

JOB_IDS

public static final ParseField JOB_IDS

ID

public static final ParseField ID

DESCRIPTION

public static final ParseField DESCRIPTION

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

STRICT_PARSER

public static final ObjectParser<Calendar.Builder,Void> STRICT_PARSER

LENIENT_PARSER

public static final ObjectParser<Calendar.Builder,Void> LENIENT_PARSER

Constructor Details

Calendar

public Calendar(String id,
 List<String> jobIds,
 @Nullable
 String description)

jobIds can be a mix of job groups and job Ids

Parameters:

id - The calendar Id

jobIds - List of job Ids or job groups

description - An optional description

Calendar

public Calendar(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

documentId

public static String documentId(String calendarId)

getId

public String getId()

documentId

public String documentId()

getJobIds

public List<String> getJobIds()

getDescription

@Nullable
public String getDescription()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static Calendar.Builder builder()