Package org.opensearch.client.opensearch.indices

Class GetIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

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

Enclosing class:

GetIndexTemplateRequest

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

Builder for GetIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetIndexTemplateRequest	build()	Builds a GetIndexTemplateRequest.
final GetIndexTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final GetIndexTemplateRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
GetIndexTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetIndexTemplateRequest.Builder	flatSettings(Boolean value)	If true, returns settings in flat format.
final GetIndexTemplateRequest.Builder	local(Boolean value)	If true, the request retrieves information from the local node only.
final GetIndexTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final GetIndexTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final GetIndexTemplateRequest.Builder	name(String value)	Name of the index template to retrieve.
protected GetIndexTemplateRequest.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 GetIndexTemplateRequest.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<GetIndexTemplateRequest.Builder,GetIndexTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetIndexTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetIndexTemplateRequest.Builder>

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final GetIndexTemplateRequest.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 GetIndexTemplateRequest.Builder flatSettings(@Nullable
 Boolean value)

If true, returns settings in flat format.

API name: flat_settings

local

@Nonnull
public final GetIndexTemplateRequest.Builder local(@Nullable
 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
@Nonnull
public final GetIndexTemplateRequest.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 GetIndexTemplateRequest.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 GetIndexTemplateRequest.Builder name(@Nullable
 String value)

Name of the index template to retrieve. Wildcard (*) expressions are supported.

API name: name

build

@Nonnull
public GetIndexTemplateRequest build()

Builds a GetIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetIndexTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.