Class Calendar
java.lang.Object
org.elasticsearch.client.ml.calendars.Calendar
- All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public class Calendar
extends java.lang.Object
implements org.elasticsearch.common.xcontent.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
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
CALENDAR_TYPE
static org.elasticsearch.common.ParseField
DESCRIPTION
static org.elasticsearch.common.ParseField
ID
static org.elasticsearch.common.ParseField
JOB_IDS
static org.elasticsearch.common.xcontent.ConstructingObjectParser<Calendar,java.lang.Void>
PARSER
-
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()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
-
Field Details
-
CALENDAR_TYPE
public static final java.lang.String CALENDAR_TYPE- See Also:
- Constant Field Values
-
JOB_IDS
public static final org.elasticsearch.common.ParseField JOB_IDS -
ID
public static final org.elasticsearch.common.ParseField ID -
DESCRIPTION
public static final org.elasticsearch.common.ParseField DESCRIPTION -
PARSER
public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<Calendar,java.lang.Void> PARSER
-
-
Constructor Details
-
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 Details
-
getId
public java.lang.String getId() -
getJobIds
public java.util.List<java.lang.String> getJobIds() -
getDescription
@Nullable public java.lang.String getDescription() -
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 interfaceorg.elasticsearch.common.xcontent.ToXContent
- 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
-