PutCalendarRequest (java-client 7.17.5 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.PutCalendarRequest

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class PutCalendarRequest
extends RequestBase
implements JsonpSerializable

Creates a calendar.

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class PutCalendarRequest.Builder
Builder for PutCalendarRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type	Field	Description
`static JsonpDeserializer<PutCalendarRequest>`	`_DESERIALIZER`	Json deserializer for `PutCalendarRequest`
`static Endpoint<PutCalendarRequest,PutCalendarResponse,ErrorResponse>`	`_ENDPOINT`	Endpoint "`ml.put_calendar`".

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`calendarId()`	Required - A string that uniquely identifies a calendar.
`java.lang.String`	`description()`	A description of the calendar.
`java.util.List<java.lang.String>`	`jobIds()`	An array of anomaly detection job identifiers.
`static PutCalendarRequest`	`of(java.util.function.Function<PutCalendarRequest.Builder,ObjectBuilder<PutCalendarRequest>> 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`	`setupPutCalendarRequestDeserializer(ObjectDeserializer<PutCalendarRequest.Builder> op)`

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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<PutCalendarRequest> _DESERIALIZER
  
  Json deserializer for PutCalendarRequest
- _ENDPOINT
  
  public static final Endpoint<PutCalendarRequest,PutCalendarResponse,ErrorResponse> _ENDPOINT
  
  Endpoint "ml.put_calendar".
Method Details
- of
  
  public static PutCalendarRequest of(java.util.function.Function<PutCalendarRequest.Builder,ObjectBuilder<PutCalendarRequest>> fn)
- calendarId
  
  public final java.lang.String calendarId()
  
  Required - A string that uniquely identifies a calendar.
  API name: calendar_id
- description
  
  @Nullable public final java.lang.String description()
  
  A description of the calendar.
  API name: description
- jobIds
  
  public final java.util.List<java.lang.String> jobIds()
  
  An array of anomaly detection job identifiers.
  API name: job_ids
- 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)
- setupPutCalendarRequestDeserializer
  
  protected static void setupPutCalendarRequestDeserializer(ObjectDeserializer<PutCalendarRequest.Builder> op)