Package org.opensearch.client.opensearch.indices

Class GetIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<GetIndexTemplateRequest>

Enclosing class:

GetIndexTemplateRequest

public static class GetIndexTemplateRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<GetIndexTemplateRequest>

Builder for GetIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetIndexTemplateRequest	build()	Builds a GetIndexTemplateRequest.
GetIndexTemplateRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the cluster-manager node.
GetIndexTemplateRequest.Builder	clusterManagerTimeout(Time value)	Period to wait for a connection to the cluster-manager node.
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(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
GetIndexTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
GetIndexTemplateRequest.Builder	name(java.lang.String value)	Comma-separated list of index template names used to limit the request.

Methods inherited from class org.opensearch.client.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 Detail

Builder

public Builder()

Method Detail

flatSettings

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

If true, returns settings in flat format.

API name: flat_settings

local

public final 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 cluster-manager node.

API name: local

masterTimeout

@Deprecated
public final GetIndexTemplateRequest.Builder masterTimeout(@Nullable
                                                           Time value)

Deprecated.

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

@Deprecated
public final GetIndexTemplateRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

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

clusterManagerTimeout

public final GetIndexTemplateRequest.Builder clusterManagerTimeout(@Nullable
                                                                   Time value)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

clusterManagerTimeout

public final GetIndexTemplateRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

name

public final 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

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.