Package org.opensearch.client.opensearch.indices

Class ExistsIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.indices.ExistsIndexTemplateRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ExistsIndexTemplateRequest

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

Builder for ExistsIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Returns:

a new builder instance.

self

@Nonnull
protected ExistsIndexTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<ExistsIndexTemplateRequest.Builder>

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Return settings in flat format.

API name: flat_settings

local

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

Return local information, do not retrieve the state from cluster-manager node.

API name: local

masterTimeout

@Deprecated
@Nonnull
public final ExistsIndexTemplateRequest.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 ExistsIndexTemplateRequest.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 ExistsIndexTemplateRequest.Builder name(String value)

Required - Name of the index template to check existence of. Wildcard (*) expressions are supported.

API name: name

build

@Nonnull
public ExistsIndexTemplateRequest build()

Builds a ExistsIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<ExistsIndexTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.