Class GetCalendarsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetCalendarsRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class GetCalendarsRequest
extends RequestBase
implements JsonpSerializable
Retrieves configuration information for calendars.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<GetCalendarsRequest>
Json deserializer forGetCalendarsRequest
static final Endpoint<GetCalendarsRequest,
GetCalendarsResponse, ErrorResponse> Endpoint "ml.get_calendars
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
A string that uniquely identifies a calendar.final Integer
from()
Skips the specified number of calendars.static GetCalendarsRequest
final Page
page()
This object is supported only when you omit the calendar identifier.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
final Integer
size()
Specifies the maximum number of calendars to obtain.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forGetCalendarsRequest
-
_ENDPOINT
Endpoint "ml.get_calendars
".
-
-
Method Details
-
of
public static GetCalendarsRequest of(Function<GetCalendarsRequest.Builder, ObjectBuilder<GetCalendarsRequest>> fn) -
calendarId
A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using_all
or*
or by omitting the calendar identifier.API name:
calendar_id
-
from
Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier.API name:
from
-
page
This object is supported only when you omit the calendar identifier.API name:
page
-
size
Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier.API name:
size
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupGetCalendarsRequestDeserializer
protected static void setupGetCalendarsRequestDeserializer(ObjectDeserializer<GetCalendarsRequest.Builder> op)
-