Package co.elastic.clients.elasticsearch.ml

Class CalendarEvent.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<CalendarEvent.Builder>

co.elastic.clients.elasticsearch.ml.CalendarEvent.Builder

All Implemented Interfaces:

WithJson<CalendarEvent.Builder>, ObjectBuilder<CalendarEvent>

Enclosing class:

CalendarEvent

public static class CalendarEvent.Builder
extends WithJsonObjectBuilderBase<CalendarEvent.Builder>
implements ObjectBuilder<CalendarEvent>

Builder for CalendarEvent.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CalendarEvent	build()	Builds a CalendarEvent.
final CalendarEvent.Builder	calendarId(String value)	A string that uniquely identifies a calendar.
final CalendarEvent.Builder	description(String value)	Required - A description of the scheduled event.
final CalendarEvent.Builder	endTime(DateTime value)	Required - The timestamp for the end of the scheduled event in milliseconds since the epoch or ISO 8601 format.
final CalendarEvent.Builder	eventId(String value)	API name: event_id
final CalendarEvent.Builder	forceTimeShift(Integer value)	Shift time by this many seconds.
protected CalendarEvent.Builder	self()
final CalendarEvent.Builder	skipModelUpdate(Boolean value)	When true the model will not be updated for this calendar period.
final CalendarEvent.Builder	skipResult(Boolean value)	When true the model will not create results for this calendar period.
final CalendarEvent.Builder	startTime(DateTime value)	Required - The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

calendarId

public final CalendarEvent.Builder calendarId(@Nullable
 String value)

A string that uniquely identifies a calendar.

API name: calendar_id

eventId

public final CalendarEvent.Builder eventId(@Nullable
 String value)

API name: event_id

description

public final CalendarEvent.Builder description(String value)

Required - A description of the scheduled event.

API name: description

endTime

public final CalendarEvent.Builder endTime(DateTime value)

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 CalendarEvent.Builder startTime(DateTime value)

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

API name: start_time

skipResult

public final CalendarEvent.Builder skipResult(@Nullable
 Boolean value)

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

API name: skip_result

skipModelUpdate

public final CalendarEvent.Builder skipModelUpdate(@Nullable
 Boolean value)

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

API name: skip_model_update

forceTimeShift

public final CalendarEvent.Builder forceTimeShift(@Nullable
 Integer value)

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

API name: force_time_shift

self

protected CalendarEvent.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<CalendarEvent.Builder>

build

public CalendarEvent build()

Builds a CalendarEvent.

Specified by:

build in interface ObjectBuilder<CalendarEvent>

Throws:

NullPointerException - if some of the required fields are null.