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 ¶
- Variables
- type ComponentTemplates
- func (r ComponentTemplates) Do(providedCtx context.Context) (Response, error)
- func (r *ComponentTemplates) ErrorTrace(errortrace bool) *ComponentTemplates
- func (r *ComponentTemplates) FilterPath(filterpaths ...string) *ComponentTemplates
- func (r *ComponentTemplates) Format(format string) *ComponentTemplates
- func (r *ComponentTemplates) H(names ...string) *ComponentTemplates
- func (r *ComponentTemplates) Header(key, value string) *ComponentTemplates
- func (r *ComponentTemplates) Help(help bool) *ComponentTemplates
- func (r *ComponentTemplates) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ComponentTemplates) Human(human bool) *ComponentTemplates
- func (r ComponentTemplates) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *ComponentTemplates) Local(local bool) *ComponentTemplates
- func (r *ComponentTemplates) MasterTimeout(duration string) *ComponentTemplates
- func (r *ComponentTemplates) Name(name string) *ComponentTemplates
- func (r ComponentTemplates) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ComponentTemplates) Pretty(pretty bool) *ComponentTemplates
- func (r *ComponentTemplates) S(names ...string) *ComponentTemplates
- func (r *ComponentTemplates) V(v bool) *ComponentTemplates
- type NewComponentTemplates
- type Response
Constants ¶
This section is empty.
Variables ¶
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/v9/operation/operation-cat-component-templates
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(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, 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 ¶
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 `"eixsts_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 ¶
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) 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
Source Files