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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetCalendarsRequest.Builder
Builder forGetCalendarsRequest
.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 forGetCalendarsRequest
static Endpoint<GetCalendarsRequest,GetCalendarsResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_calendars
". -
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.static GetCalendarsRequest
of(java.util.function.Function<GetCalendarsRequest.Builder,ObjectBuilder<GetCalendarsRequest>> fn)
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
setupGetCalendarsRequestDeserializer(ObjectDeserializer<GetCalendarsRequest.Builder> op)
java.lang.Integer
size()
Specifies the maximum number of calendars to obtain.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
Json deserializer forGetCalendarsRequest
-
_ENDPOINT
Endpoint "ml.get_calendars
".
-
-
Method Details
-
of
public static GetCalendarsRequest of(java.util.function.Function<GetCalendarsRequest.Builder,ObjectBuilder<GetCalendarsRequest>> fn) -
calendarId
@Nullable public final java.lang.String 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
@Nullable public final java.lang.Integer 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
@Nullable public final java.lang.Integer 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)
-