Package co.elastic.clients.elasticsearch.ml

Class GetCalendarsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetCalendarsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class GetCalendarsRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

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<GetCalendarsRequest>	_DESERIALIZER	Json deserializer for GetCalendarsRequest
static Endpoint<GetCalendarsRequest,GetCalendarsResponse,ElasticsearchError>	ENDPOINT	Endpoint "ml.get_calendars".

Constructor Summary

Constructors

Constructor	Description
GetCalendarsRequest(GetCalendarsRequest.Builder builder)
GetCalendarsRequest(java.util.function.Function<GetCalendarsRequest.Builder,GetCalendarsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.String	calendarId()	A string that uniquely identifies a calendar.
java.lang.Integer	from()	Skips the specified number of calendars.
Page	page()	API name: page
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	setupGetCalendarsRequestDeserializer(DelegatingDeserializer<GetCalendarsRequest.Builder> op)
java.lang.Integer	size()	Specifies the maximum number of calendars to obtain.

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GetCalendarsRequest> _DESERIALIZER

Json deserializer for GetCalendarsRequest

ENDPOINT

public static final Endpoint<GetCalendarsRequest,GetCalendarsResponse,ElasticsearchError> ENDPOINT

Endpoint "ml.get_calendars".

Constructor Details

GetCalendarsRequest

public GetCalendarsRequest(GetCalendarsRequest.Builder builder)

GetCalendarsRequest

public GetCalendarsRequest(java.util.function.Function<GetCalendarsRequest.Builder,GetCalendarsRequest.Builder> fn)

Method Details

calendarId

@Nullable
public java.lang.String calendarId()

A string that uniquely identifies a calendar.

API name: calendar_id

from

@Nullable
public java.lang.Integer from()

Skips the specified number of calendars.

API name: from

size

@Nullable
public java.lang.Integer size()

Specifies the maximum number of calendars to obtain.

API name: size

page

@Nullable
public Page page()

API name: page

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)

setupGetCalendarsRequestDeserializer

protected static void setupGetCalendarsRequestDeserializer(DelegatingDeserializer<GetCalendarsRequest.Builder> op)