Package org.opensearch.client.opensearch.indices

Class GetTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.GetTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<GetTemplateRequest>

Enclosing class:

GetTemplateRequest

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

Builder for GetTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetTemplateRequest	build()	Builds a GetTemplateRequest.
GetTemplateRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout for connection to cluster-manager node
GetTemplateRequest.Builder	clusterManagerTimeout(Time value)	Explicit operation timeout for connection to cluster-manager node
GetTemplateRequest.Builder	flatSettings(java.lang.Boolean value)	Return settings in flat format (default: false)
GetTemplateRequest.Builder	local(java.lang.Boolean value)	Return local information, do not retrieve the state from cluster-manager node (default: false)
GetTemplateRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
GetTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
GetTemplateRequest.Builder	name(java.lang.String value, java.lang.String... values)	The comma separated names of the index templates
GetTemplateRequest.Builder	name(java.util.List<java.lang.String> list)	The comma separated names of the index templates

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 GetTemplateRequest.Builder flatSettings(@Nullable
                                                     java.lang.Boolean value)

Return settings in flat format (default: false)

API name: flat_settings

local

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

Return local information, do not retrieve the state from cluster-manager node (default: false)

API name: local

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

masterTimeout

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

Deprecated.

Explicit operation timeout for connection to master node

API name: master_timeout

clusterManagerTimeout

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

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

clusterManagerTimeout

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

Explicit operation timeout for connection to cluster-manager node

API name: cluster_manager_timeout

name

public final GetTemplateRequest.Builder name(java.util.List<java.lang.String> list)

The comma separated names of the index templates

API name: name

Adds all elements of list to name.

name

public final GetTemplateRequest.Builder name(java.lang.String value,
                                             java.lang.String... values)

The comma separated names of the index templates

API name: name

Adds one or more values to name.

build

public GetTemplateRequest build()

Builds a GetTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetTemplateRequest>

Throws:

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