Package co.elastic.clients.elasticsearch.cluster

Class GetComponentTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetComponentTemplateRequest.Builder>

co.elastic.clients.elasticsearch.cluster.GetComponentTemplateRequest.Builder

All Implemented Interfaces:

WithJson<GetComponentTemplateRequest.Builder>, ObjectBuilder<GetComponentTemplateRequest>

Enclosing class:

GetComponentTemplateRequest

public static class GetComponentTemplateRequest.Builder
extends RequestBase.AbstractBuilder<GetComponentTemplateRequest.Builder>
implements ObjectBuilder<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	flatSettings(Boolean value)	If true, returns settings in flat format.
final GetComponentTemplateRequest.Builder	includeDefaults(Boolean value)	Return all default configurations for the component template
final GetComponentTemplateRequest.Builder	local(Boolean value)	Deprecated. 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
final GetComponentTemplateRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final GetComponentTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final GetComponentTemplateRequest.Builder	name(String value)	Name of component template to retrieve.
protected GetComponentTemplateRequest.Builder	self()
final GetComponentTemplateRequest.Builder	settingsFilter(String value, String... values)	Filter out results, for example to filter out sensitive information.
final GetComponentTemplateRequest.Builder	settingsFilter(List<String> list)	Filter out results, for example to filter out sensitive information.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

flatSettings

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

If true, returns settings in flat format.

API name: flat_settings

includeDefaults

public final GetComponentTemplateRequest.Builder includeDefaults(@Nullable
 Boolean value)

Return all default configurations for the component template

API name: include_defaults

local

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

Deprecated.

9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.

If true, the request retrieves information from the local node only. If false, information is retrieved from the master node.

API name: local

masterTimeout

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

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

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

Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

name

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

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

API name: name

settingsFilter

public final GetComponentTemplateRequest.Builder settingsFilter(List<String> list)

Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys

API name: settings_filter

Adds all elements of list to settingsFilter.

settingsFilter

public final GetComponentTemplateRequest.Builder settingsFilter(String value,
 String... values)

Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys

API name: settings_filter

Adds one or more values to settingsFilter.

self

protected GetComponentTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<GetComponentTemplateRequest.Builder>

build

public GetComponentTemplateRequest build()

Builds a GetComponentTemplateRequest.

Specified by:

build in interface ObjectBuilder<GetComponentTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.