Package co.elastic.clients.elasticsearch.cluster

Class GetComponentTemplateRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.cluster.GetComponentTemplateRequest

public class GetComponentTemplateRequest
extends RequestBase

Get component templates. Get information about component templates.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetComponentTemplateRequest.Builder	Builder for GetComponentTemplateRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint<GetComponentTemplateRequest,GetComponentTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "cluster.get_component_template".

Method Summary

Modifier and Type	Method	Description
final Boolean	flatSettings()	If true, returns settings in flat format.
final Boolean	includeDefaults()	Return all default configurations for the component template
final Boolean	local()	Deprecated. 9.0.0 This parameter has no effect, is now deprecated, and will be removed in a future version.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final String	name()	Name of component template to retrieve.
static GetComponentTemplateRequest	of(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)
GetComponentTemplateRequest.Builder	rebuild()
final List<String>	settingsFilter()	Filter out results, for example to filter out sensitive information.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

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

Field Details

_ENDPOINT

public static final Endpoint<GetComponentTemplateRequest,GetComponentTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "cluster.get_component_template".

Method Details

of

public static GetComponentTemplateRequest of(Function<GetComponentTemplateRequest.Builder,ObjectBuilder<GetComponentTemplateRequest>> fn)

flatSettings

@Nullable
public final Boolean flatSettings()

If true, returns settings in flat format.

API name: flat_settings

includeDefaults

@Nullable
public final Boolean includeDefaults()

Return all default configurations for the component template

API name: include_defaults

local

@Deprecated
@Nullable
public final Boolean local()

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

@Nullable
public final Time masterTimeout()

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

@Nullable
public final String name()

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

API name: name

settingsFilter

public final List<String> settingsFilter()

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

API name: settings_filter

rebuild

public GetComponentTemplateRequest.Builder rebuild()

Returns:

New GetComponentTemplateRequest.Builder initialized with field values of this instance