Package org.opensearch.client.opensearch.cat

Class TemplatesRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder<TemplatesRequest.Builder>

org.opensearch.client.opensearch.cat.TemplatesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

TemplatesRequest

public static class TemplatesRequest.Builder
extends CatRequestBase.AbstractBuilder<TemplatesRequest.Builder>
implements CopyableBuilder<TemplatesRequest.Builder,TemplatesRequest>

Builder for TemplatesRequest.

Field Summary

Fields inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, sort

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TemplatesRequest	build()	Builds a TemplatesRequest.
final TemplatesRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time allowed to establish a connection to the cluster manager node.
final TemplatesRequest.Builder	clusterManagerTimeout(Time value)	The amount of time allowed to establish a connection to the cluster manager node.
TemplatesRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TemplatesRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final TemplatesRequest.Builder	masterTimeout(Time value)	Deprecated.
final TemplatesRequest.Builder	name(String value)	The name of the template to return.
protected TemplatesRequest.Builder	self()

Methods inherited from class org.opensearch.client.opensearch.cat.CatRequestBase.AbstractBuilder

headers, headers, sort, sort

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 TemplatesRequest.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<TemplatesRequest.Builder,TemplatesRequest>

Returns:

a new builder instance.

self

@Nonnull
protected TemplatesRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<TemplatesRequest.Builder>

clusterManagerTimeout

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

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

The amount of time allowed to establish a connection to the cluster manager node.

API name: cluster_manager_timeout

masterTimeout

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

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

masterTimeout

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

Deprecated.

The amount of time allowed to establish a connection to the cluster manager node.

API name: master_timeout

name

@Nonnull
public final TemplatesRequest.Builder name(@Nullable
 String value)

The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

API name: name

build

@Nonnull
public TemplatesRequest build()

Builds a TemplatesRequest.

Specified by:

build in interface ObjectBuilder<TemplatesRequest>

Throws:

NullPointerException - if some of the required fields are null.