componenttemplates

package
v9.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 29, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

Get component templates.

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

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

Index

Constants

This section is empty.

Variables

View Source 
var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Functions

This section is empty.

Types

type ComponentTemplates 

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

func New 

func New(tp elastictransport.Interface) *ComponentTemplates

Get component templates.

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

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

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates

func (*ComponentTemplates) Bytes added in v9.2.0 

func (r *ComponentTemplates) Bytes(bytes bytes.Bytes) *ComponentTemplates

Bytes Sets the units for columns that contain a byte-size value. Note that byte-size value units work in terms of powers of 1024. For instance `1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are rendered with a suffix such as `kb`, `mb`, or `gb`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. If given, byte-size values are rendered as an integer with no suffix, representing the value of the column in the chosen unit. Values that are not an exact multiple of the chosen unit are rounded down. API name: bytes

func (ComponentTemplates) Do 

func (r ComponentTemplates) Do(providedCtx context.Context) (Response, error)

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

func (*ComponentTemplates) ErrorTrace 

func (r *ComponentTemplates) ErrorTrace(errortrace bool) *ComponentTemplates

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

func (*ComponentTemplates) FilterPath 

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

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

func (*ComponentTemplates) Format 

func (r *ComponentTemplates) Format(format string) *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 

func (r *ComponentTemplates) H(catcomponentcolumns ...catcomponentcolumn.CatComponentColumn) *ComponentTemplates

H A comma-separated list of columns names to display. It supports simple wildcards. API name: h

func (*ComponentTemplates) Header 

func (r *ComponentTemplates) Header(key, value string) *ComponentTemplates

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

func (*ComponentTemplates) Help 

func (r *ComponentTemplates) Help(help bool) *ComponentTemplates

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

func (*ComponentTemplates) HttpRequest 

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

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

func (*ComponentTemplates) Human 

func (r *ComponentTemplates) Human(human bool) *ComponentTemplates

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

func (ComponentTemplates) IsSuccess 

func (r ComponentTemplates) IsSuccess(providedCtx context.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 

func (r *ComponentTemplates) Local(local bool) *ComponentTemplates

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

func (*ComponentTemplates) MasterTimeout 

func (r *ComponentTemplates) MasterTimeout(duration string) *ComponentTemplates

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

func (*ComponentTemplates) Name 

func (r *ComponentTemplates) Name(name string) *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 

func (r ComponentTemplates) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*ComponentTemplates) Pretty 

func (r *ComponentTemplates) Pretty(pretty bool) *ComponentTemplates

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

func (*ComponentTemplates) S 

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) Time added in v9.2.0 

func (r *ComponentTemplates) Time(time timeunit.TimeUnit) *ComponentTemplates

Time Sets the units for columns that contain a time duration. If omitted, time duration values are rendered with a suffix such as `ms`, `s`, `m` or `h`, chosen such that the numeric value of the column is as small as possible whilst still being at least `1.0`. If given, time duration values are rendered as an integer with no suffix. Values that are not an exact multiple of the chosen unit are rounded down. API name: time

func (*ComponentTemplates) V 

func (r *ComponentTemplates) V(v bool) *ComponentTemplates

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

type NewComponentTemplates 

type NewComponentTemplates func() *ComponentTemplates

NewComponentTemplates type alias for index.

func NewComponentTemplatesFunc 

func NewComponentTemplatesFunc(tp elastictransport.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 

type Response []types.CatComponentTemplate

func NewResponse 

func NewResponse() Response

NewResponse returns a Response

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.