Package org.opensearch.client.opensearch.indices

Class GetIndexTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetIndexTemplateRequest

All Implemented Interfaces:

ToJsonp

public final class GetIndexTemplateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetIndexTemplateRequest.Builder	Builder for GetIndexTemplateRequest.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<GetIndexTemplateRequest>	DESERIALIZER	Json deserializer for GetIndexTemplateRequest
static Endpoint<GetIndexTemplateRequest,GetIndexTemplateResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.get_index_template".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GetIndexTemplateRequest(GetIndexTemplateRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	flatSettings()	If true, returns settings in flat format.
java.lang.Boolean	includeTypeName()	If true, a mapping type is expected in the body of mappings.
java.lang.Boolean	local()	If true, the request retrieves information from the local node only.
jakarta.json.JsonValue	masterTimeout()	Period to wait for a connection to the master node.
java.lang.String	name()	Comma-separated list of index template names used to limit the request.
protected static void	setupGetIndexTemplateRequestDeserializer(DelegatingDeserializer<GetIndexTemplateRequest.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DESERIALIZER

public static final JsonpDeserializer<GetIndexTemplateRequest> DESERIALIZER

Json deserializer for GetIndexTemplateRequest

ENDPOINT

public static final Endpoint<GetIndexTemplateRequest,GetIndexTemplateResponse,OpenSearchError> ENDPOINT

Endpoint "indices.get_index_template".

Constructor Details

GetIndexTemplateRequest

protected GetIndexTemplateRequest(GetIndexTemplateRequest.Builder builder)

Method Details

name

@Nullable public java.lang.String name()

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

local

@Nullable public java.lang.Boolean 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

flatSettings

@Nullable public java.lang.Boolean flatSettings()

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

includeTypeName

@Nullable public java.lang.Boolean includeTypeName()

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

masterTimeout

@Nullable public jakarta.json.JsonValue 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

toJsonp

public void toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

toJsonp in interface ToJsonp

toJsonpInternal

protected void toJsonpInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

setupGetIndexTemplateRequestDeserializer

protected static void setupGetIndexTemplateRequestDeserializer(DelegatingDeserializer<GetIndexTemplateRequest.Builder> op)