Package org.opensearch.client.opensearch.indices

Class GetTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetTemplateRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>, MutableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>, ObjectBuilder<GetTemplateRequest>

Enclosing class:

GetTemplateRequest

public static class GetTemplateRequest.Builder
extends RequestBase.AbstractBuilder<GetTemplateRequest.Builder>
implements CopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>

Builder for GetTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetTemplateRequest	build()	Builds a GetTemplateRequest.
final GetTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final GetTemplateRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
GetTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetTemplateRequest.Builder	flatSettings(Boolean value)	If true, returns settings in flat format.
final GetTemplateRequest.Builder	local(Boolean value)	If true, the request retrieves information from the local node only.
final GetTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final GetTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final GetTemplateRequest.Builder	name(String value, String... values)	Comma-separated list of index template names used to limit the request.
final GetTemplateRequest.Builder	name(List<String> list)	Comma-separated list of index template names used to limit the request.
protected GetTemplateRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public GetTemplateRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<GetTemplateRequest.Builder,GetTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetTemplateRequest.Builder>

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final GetTemplateRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

flatSettings

@Nonnull
public final GetTemplateRequest.Builder flatSettings(@Nullable
 Boolean value)

If true, returns settings in flat format.

API name: flat_settings

local

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

If true, the request retrieves information from the local node only.

API name: local

masterTimeout

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

Deprecated.

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: master_timeout

masterTimeout

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

Deprecated.

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: master_timeout

name

@Nonnull
public final GetTemplateRequest.Builder name(List<String> list)

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.

API name: name

Adds all elements of list to name.

name

@Nonnull
public final GetTemplateRequest.Builder name(String value,
 String... values)

Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. To return all index templates, omit this parameter or use a value of _all or *.

API name: name

Adds one or more values to name.

build

@Nonnull
public GetTemplateRequest build()

Builds a GetTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.