Class GetIndexTemplateRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetIndexTemplateRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetIndexTemplateRequest.Builder
- All Implemented Interfaces:
WithJson<GetIndexTemplateRequest.Builder>
,ObjectBuilder<GetIndexTemplateRequest>
- Enclosing class:
- GetIndexTemplateRequest
public static class GetIndexTemplateRequest.Builder
extends RequestBase.AbstractBuilder<GetIndexTemplateRequest.Builder>
implements ObjectBuilder<GetIndexTemplateRequest>
Builder for
GetIndexTemplateRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds aGetIndexTemplateRequest
.flatSettings
(Boolean value) If true, returns settings in flat format.includeTypeName
(Boolean value) If true, a mapping type is expected in the body of mappings.If true, 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.protected GetIndexTemplateRequest.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
If true, returns settings in flat format.API name:
flat_settings
-
includeTypeName
If true, a mapping type is expected in the body of mappings.API name:
include_type_name
-
local
If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.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 GetIndexTemplateRequest.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.API name:
name
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetIndexTemplateRequest.Builder>
-
build
Builds aGetIndexTemplateRequest
.- Specified by:
build
in interfaceObjectBuilder<GetIndexTemplateRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-