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
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetIndexTemplateRequest
build()
Builds aGetIndexTemplateRequest
.GetIndexTemplateRequest.Builder
flatSettings(java.lang.Boolean value)
If true, returns settings in flat format.GetIndexTemplateRequest.Builder
local(java.lang.Boolean value)
If true, the request retrieves information from the local node only.GetIndexTemplateRequest.Builder
masterTimeout(Time value)
Period to wait for a connection to the master node.GetIndexTemplateRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Period to wait for a connection to the master node.GetIndexTemplateRequest.Builder
name(java.lang.String value)
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
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
-
flatSettings
If true, returns settings in flat format.API name:
flat_settings
-
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(java.util.function.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:
java.lang.NullPointerException
- if some of the required fields are null.
-