Package org.opensearch.client.opensearch.cluster

Class GetComponentTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.cluster.GetComponentTemplateRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

GetComponentTemplateRequest

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

Builder for GetComponentTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetComponentTemplateRequest	build()	Builds a GetComponentTemplateRequest.
final GetComponentTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The amount of time to wait for a response from the cluster manager node.
final GetComponentTemplateRequest.Builder	clusterManagerTimeout(Time value)	The amount of time to wait for a response from the cluster manager node.
GetComponentTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final GetComponentTemplateRequest.Builder	flatSettings(Boolean value)	Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings.
final GetComponentTemplateRequest.Builder	local(Boolean value)	When true, the request retrieves information from the local node only.
final GetComponentTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final GetComponentTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final GetComponentTemplateRequest.Builder	name(String value)	The name of the component template to retrieve.
protected GetComponentTemplateRequest.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 GetComponentTemplateRequest.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<GetComponentTemplateRequest.Builder,GetComponentTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected GetComponentTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetComponentTemplateRequest.Builder>

clusterManagerTimeout

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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

clusterManagerTimeout

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

The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

API name: cluster_manager_timeout

flatSettings

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

Whether to return settings in the flat form, which can improve readability, especially for heavily nested settings. For example, the flat form of "cluster": { "max_shards_per_node": 500 } is "cluster.max_shards_per_node": "500".

API name: flat_settings

local

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

When true, the request retrieves information from the local node only. When false, information is retrieved from the cluster manager node.

API name: local

masterTimeout

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

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

masterTimeout

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

Deprecated.

A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts 0 without a unit and -1 to indicate an unspecified value.

API name: master_timeout

name

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

The name of the component template to retrieve. Wildcard (*) expressions are supported.

API name: name

build

@Nonnull
public GetComponentTemplateRequest build()

Builds a GetComponentTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetComponentTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.