Class GetTemplateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetTemplateRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetTemplateRequest.Builder
- All Implemented Interfaces:
WithJson<GetTemplateRequest.Builder>
,ObjectBuilder<GetTemplateRequest>
- Enclosing class:
- GetTemplateRequest
public static class GetTemplateRequest.Builder
extends RequestBase.AbstractBuilder<GetTemplateRequest.Builder>
implements ObjectBuilder<GetTemplateRequest>
Builder for
GetTemplateRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGetTemplateRequest
.flatSettings
(Boolean value) Iftrue
, returns settings in flat format.Iftrue
, the request retrieves information from the local node only.masterTimeout
(Time value) Period to wait for a connection to the master node.Period to wait for a connection to the master node.Comma-separated list of index template names used to limit the request.Comma-separated list of index template names used to limit the request.protected GetTemplateRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
flatSettings
Iftrue
, returns settings in flat format.API name:
flat_settings
-
local
Iftrue
, the request retrieves information from the local node only.API name:
local
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
masterTimeout
public final GetTemplateRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
name
Comma-separated list of index template names used to limit the request. Wildcard (*
) expressions are supported. To return all index templates, omit this parameter or use a value of_all
or*
.API name:
name
Adds all elements of
list
toname
. -
name
Comma-separated list of index template names used to limit the request. Wildcard (*
) expressions are supported. To return all index templates, omit this parameter or use a value of_all
or*
.API name:
name
Adds one or more values to
name
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetTemplateRequest.Builder>
-
build
Builds aGetTemplateRequest
.- Specified by:
build
in interfaceObjectBuilder<GetTemplateRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-