getcomponenttemplate

Documentation

Overview

Get component templates. Retrieves information about component templates.

Index

• Variables
• type GetComponentTemplate
  • func New(tp elastictransport.Interface) *GetComponentTemplate
  • func (r GetComponentTemplate) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetComponentTemplate) ErrorTrace(errortrace bool) *GetComponentTemplate
  • func (r *GetComponentTemplate) FilterPath(filterpaths ...string) *GetComponentTemplate
  • func (r *GetComponentTemplate) FlatSettings(flatsettings bool) *GetComponentTemplate
  • func (r *GetComponentTemplate) Header(key, value string) *GetComponentTemplate
  • func (r *GetComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetComponentTemplate) Human(human bool) *GetComponentTemplate
  • func (r *GetComponentTemplate) IncludeDefaults(includedefaults bool) *GetComponentTemplate
  • func (r GetComponentTemplate) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetComponentTemplate) Local(local bool) *GetComponentTemplate
  • func (r *GetComponentTemplate) MasterTimeout(duration string) *GetComponentTemplate
  • func (r *GetComponentTemplate) Name(name string) *GetComponentTemplate
  • func (r GetComponentTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetComponentTemplate) Pretty(pretty bool) *GetComponentTemplate
• type NewGetComponentTemplate
  • func NewGetComponentTemplateFunc(tp elastictransport.Interface) NewGetComponentTemplate
• type Response
  • func NewResponse() *Response

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.

Types

type GetComponentTemplate

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

func New

func New(tp elastictransport.Interface) *GetComponentTemplate

Get component templates. Retrieves information about component templates.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html

func (GetComponentTemplate) Do

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

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

func (*GetComponentTemplate) ErrorTrace

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

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

func (*GetComponentTemplate) FilterPath

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

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

func (*GetComponentTemplate) FlatSettings

func (r *GetComponentTemplate) FlatSettings(flatsettings bool) *GetComponentTemplate

FlatSettings If `true`, returns settings in flat format. API name: flat_settings

func (*GetComponentTemplate) Header

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

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

func (*GetComponentTemplate) HttpRequest

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

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

func (*GetComponentTemplate) Human

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

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 (*GetComponentTemplate) IncludeDefaults

func (r *GetComponentTemplate) IncludeDefaults(includedefaults bool) *GetComponentTemplate

IncludeDefaults Return all default configurations for the component template (default: false) API name: include_defaults

func (GetComponentTemplate) IsSuccess

func (r GetComponentTemplate) 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 (*GetComponentTemplate) Local

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

Local If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. API name: local

func (*GetComponentTemplate) MasterTimeout

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

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

func (*GetComponentTemplate) Name

func (r *GetComponentTemplate) Name(name string) *GetComponentTemplate

Name Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. API Name: name

func (GetComponentTemplate) Perform

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

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

func (*GetComponentTemplate) Pretty

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

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

type NewGetComponentTemplate

type NewGetComponentTemplate func() *GetComponentTemplate

NewGetComponentTemplate type alias for index.

func NewGetComponentTemplateFunc

func NewGetComponentTemplateFunc(tp elastictransport.Interface) NewGetComponentTemplate

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

type Response

type Response struct {
	ComponentTemplates []types.ClusterComponentTemplate `json:"component_templates"`
}

Response holds the response body struct for the package getcomponenttemplate

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/cluster/get_component_template/ClusterGetComponentTemplateResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response