Package co.elastic.clients.elasticsearch.ml

Class CalendarEvent

java.lang.Object

co.elastic.clients.elasticsearch.ml.CalendarEvent

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class CalendarEvent
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CalendarEvent.Builder	Builder for CalendarEvent.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CalendarEvent>	_DESERIALIZER	Json deserializer for CalendarEvent

Method Summary

Modifier and Type	Method	Description
final String	calendarId()	A string that uniquely identifies a calendar.
final String	description()	Required - A description of the scheduled event.
final DateTime	endTime()	Required - The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.
final String	eventId()	API name: event_id
final Integer	forceTimeShift()	Shift time by this many seconds.
static CalendarEvent	of(Function<CalendarEvent.Builder,ObjectBuilder<CalendarEvent>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCalendarEventDeserializer(ObjectDeserializer<CalendarEvent.Builder> op)
final Boolean	skipModelUpdate()	When true the model will not be updated for this calendar period.
final Boolean	skipResult()	When true the model will not create results for this calendar period.
final DateTime	startTime()	Required - The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CalendarEvent> _DESERIALIZER

Json deserializer for CalendarEvent

Method Details

of

public static CalendarEvent of(Function<CalendarEvent.Builder,ObjectBuilder<CalendarEvent>> fn)

calendarId

@Nullable
public final String calendarId()

A string that uniquely identifies a calendar.

API name: calendar_id

eventId

@Nullable
public final String eventId()

API name: event_id

description

public final String description()

Required - A description of the scheduled event.

API name: description

endTime

public final DateTime endTime()

Required - The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.

API name: end_time

startTime

public final DateTime startTime()

Required - The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.

API name: start_time

skipResult

@Nullable
public final Boolean skipResult()

When true the model will not create results for this calendar period.

API name: skip_result

skipModelUpdate

@Nullable
public final Boolean skipModelUpdate()

When true the model will not be updated for this calendar period.

API name: skip_model_update

forceTimeShift

@Nullable
public final Integer forceTimeShift()

Shift time by this many seconds. For example adjust time for daylight savings changes

API name: force_time_shift

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupCalendarEventDeserializer

protected static void setupCalendarEventDeserializer(ObjectDeserializer<CalendarEvent.Builder> op)