type ComponentTemplates struct {// contains filtered or unexported fields}

funcNew¶

func New(tpelastictransport.Interface) *ComponentTemplates

Get component templates.

Get information about component templates in a cluster.Component templates are building blocks for constructing index templates thatspecify index mappings, settings, and aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the commandline or Kibana console.They are not intended for use by applications. For application consumption,use the get component template API.

https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-component-templates.html

func (ComponentTemplates)Do¶

func (rComponentTemplates) Do(providedCtxcontext.Context) (Response,error)

Do runs the request through the transport, handle the response and returns a componenttemplates.Response

func (*ComponentTemplates)ErrorTrace¶added inv8.14.0

func (r *ComponentTemplates) ErrorTrace(errortracebool) *ComponentTemplates

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errorswhen they occur.API name: error_trace

func (*ComponentTemplates)FilterPath¶added inv8.14.0

func (r *ComponentTemplates) FilterPath(filterpaths ...string) *ComponentTemplates

FilterPath Comma-separated list of filters in dot notation which reduce the responsereturned by Elasticsearch.API name: filter_path

func (*ComponentTemplates)Format¶added inv8.14.0

func (r *ComponentTemplates) Format(formatstring) *ComponentTemplates

Format Specifies the format to return the columnar data in, can be set to`text`, `json`, `cbor`, `yaml`, or `smile`.API name: format

func (*ComponentTemplates)H¶added inv8.14.0

func (r *ComponentTemplates) H(names ...string) *ComponentTemplates

H List of columns to appear in the response. Supports simple wildcards.API name: h

func (*ComponentTemplates)Header¶

func (r *ComponentTemplates) Header(key, valuestring) *ComponentTemplates

Header set a key, value pair in the ComponentTemplates headers map.

func (*ComponentTemplates)Help¶added inv8.14.0

func (r *ComponentTemplates) Help(helpbool) *ComponentTemplates

Help When set to `true` will output available columns. This optioncan't be combined with any other query string option.API name: help

func (*ComponentTemplates)HttpRequest¶

func (r *ComponentTemplates) HttpRequest(ctxcontext.Context) (*http.Request,error)

HttpRequest returns the http.Request object built from thegiven parameters.

func (*ComponentTemplates)Human¶added inv8.14.0

func (r *ComponentTemplates) Human(humanbool) *ComponentTemplates

Human When set to `true` will return statistics in a format suitable for humans.For example `"exists_time": "1h"` for humans and`"eixsts_time_in_millis": 3600000` for computers. When disabled the humanreadable values will be omitted. This makes sense for responses beingconsumedonly by machines.API name: human

func (ComponentTemplates)IsSuccess¶

func (rComponentTemplates) IsSuccess(providedCtxcontext.Context) (bool,error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean.This only exists for endpoints without a request payload and allows for quick control flow.

func (*ComponentTemplates)Local¶added inv8.14.0

func (r *ComponentTemplates) Local(localbool) *ComponentTemplates

Local If `true`, the request computes the list of selected nodes from thelocal cluster state. If `false` the list of selected nodes are computedfrom the cluster state of the master node. In both cases the coordinatingnode will send requests for further information to each selected node.API name: local

func (*ComponentTemplates)MasterTimeout¶added inv8.14.0

func (r *ComponentTemplates) MasterTimeout(durationstring) *ComponentTemplates

MasterTimeout The period to wait for a connection to the master node.API name: master_timeout

func (*ComponentTemplates)Name¶

func (r *ComponentTemplates) Name(namestring) *ComponentTemplates

Name The name of the component template.It accepts wildcard expressions.If it is omitted, all component templates are returned.API Name: name

func (ComponentTemplates)Perform¶added inv8.7.0

func (rComponentTemplates) Perform(providedCtxcontext.Context) (*http.Response,error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*ComponentTemplates)Pretty¶added inv8.14.0

func (r *ComponentTemplates) Pretty(prettybool) *ComponentTemplates

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only usethis option for debugging only.API name: pretty

func (*ComponentTemplates)S¶added inv8.14.0

func (r *ComponentTemplates) S(names ...string) *ComponentTemplates

S List of columns that determine how the table should be sorted.Sorting defaults to ascending and can be changed by setting `:asc`or `:desc` as a suffix to the column name.API name: s

func (*ComponentTemplates)V¶added inv8.14.0

func (r *ComponentTemplates) V(vbool) *ComponentTemplates

V When set to `true` will enable verbose output.API name: v

type NewComponentTemplates func() *ComponentTemplates

funcNewComponentTemplatesFunc¶

func NewComponentTemplatesFunc(tpelastictransport.Interface)NewComponentTemplates

NewComponentTemplatesFunc returns a new instance of ComponentTemplates with the provided transport.Used in the index of the library this allows to retrieve every apis in once place.

type Response []types.CatComponentTemplate

funcNewResponse¶added inv8.7.0

func NewResponse()Response

NewResponse returns a Response