Package org.opensearch.client.opensearch.indices

Class GetIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.indices.GetIndexTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetIndexTemplateRequest>

Enclosing class:

GetIndexTemplateRequest

public static class GetIndexTemplateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<GetIndexTemplateRequest>

Builder for GetIndexTemplateRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetIndexTemplateRequest	build()	Builds a GetIndexTemplateRequest.
GetIndexTemplateRequest.Builder	flatSettings(java.lang.Boolean value)	If true, returns settings in flat format.
GetIndexTemplateRequest.Builder	includeTypeName(java.lang.Boolean value)	If true, a mapping type is expected in the body of mappings.
GetIndexTemplateRequest.Builder	local(java.lang.Boolean value)	If true, the request retrieves information from the local node only.
GetIndexTemplateRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	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.

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

name

public GetIndexTemplateRequest.Builder name(@Nullable java.lang.String value)

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. API name: name

local

public GetIndexTemplateRequest.Builder local(@Nullable java.lang.Boolean value)

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

flatSettings

public GetIndexTemplateRequest.Builder flatSettings(@Nullable java.lang.Boolean value)

If true, returns settings in flat format. API name: flat_settings

includeTypeName

public GetIndexTemplateRequest.Builder includeTypeName(@Nullable java.lang.Boolean value)

If true, a mapping type is expected in the body of mappings. API name: include_type_name

masterTimeout

public GetIndexTemplateRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue value)

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

build

public GetIndexTemplateRequest build()

Builds a GetIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetIndexTemplateRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.