Class Calendar
- java.lang.Object
-
- org.elasticsearch.client.ml.calendars.Calendar
-
- All Implemented Interfaces:
ToXContent
,ToXContentObject
public class Calendar extends java.lang.Object implements ToXContentObject
A simple calendar object for scheduled (special) events. The calendar consists of a name an a list of job Ids or job groups the events are stored separately and reference the calendar.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CALENDAR_TYPE
static ParseField
DESCRIPTION
static ParseField
ID
static ParseField
JOB_IDS
static ConstructingObjectParser<Calendar,java.lang.Void>
PARSER
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description Calendar(java.lang.String id, java.util.List<java.lang.String> jobIds, java.lang.String description)
jobIds
can be a mix of job groups and job Ids
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.String
getDescription()
java.lang.String
getId()
java.util.List<java.lang.String>
getJobIds()
int
hashCode()
XContentBuilder
toXContent(XContentBuilder builder, 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
-
-
-
-
Field Detail
-
CALENDAR_TYPE
public static final java.lang.String CALENDAR_TYPE
- See Also:
- Constant Field Values
-
JOB_IDS
public static final ParseField JOB_IDS
-
ID
public static final ParseField ID
-
DESCRIPTION
public static final ParseField DESCRIPTION
-
PARSER
public static final ConstructingObjectParser<Calendar,java.lang.Void> PARSER
-
-
Constructor Detail
-
Calendar
public Calendar(java.lang.String id, java.util.List<java.lang.String> jobIds, @Nullable java.lang.String description)
jobIds
can be a mix of job groups and job Ids- Parameters:
id
- The calendar IdjobIds
- List of job Ids or job groupsdescription
- An optional description
-
-
Method Detail
-
getId
public java.lang.String getId()
-
getJobIds
public java.util.List<java.lang.String> getJobIds()
-
getDescription
@Nullable public java.lang.String getDescription()
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-