Class GetCalendarsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<GetCalendarsRequest.Builder>
co.elastic.clients.elasticsearch.ml.GetCalendarsRequest.Builder
- All Implemented Interfaces:
WithJson<GetCalendarsRequest.Builder>
,ObjectBuilder<GetCalendarsRequest>
- Enclosing class:
- GetCalendarsRequest
public static class GetCalendarsRequest.Builder extends WithJsonObjectBuilderBase<GetCalendarsRequest.Builder> implements ObjectBuilder<GetCalendarsRequest>
Builder for
GetCalendarsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetCalendarsRequest
build()
Builds aGetCalendarsRequest
.GetCalendarsRequest.Builder
calendarId(java.lang.String value)
A string that uniquely identifies a calendar.GetCalendarsRequest.Builder
from(java.lang.Integer value)
Skips the specified number of calendars.GetCalendarsRequest.Builder
page(Page value)
This object is supported only when you omit the calendar identifier.GetCalendarsRequest.Builder
page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)
This object is supported only when you omit the calendar identifier.protected GetCalendarsRequest.Builder
self()
GetCalendarsRequest.Builder
size(java.lang.Integer value)
Specifies the maximum number of calendars to obtain.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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
-
page
public final GetCalendarsRequest.Builder page(java.util.function.Function<Page.Builder,ObjectBuilder<Page>> fn)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
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<GetCalendarsRequest.Builder>
-
build
Builds aGetCalendarsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetCalendarsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-