existscomponenttemplate

Documentation

Overview

Check component templates. Returns information about whether a particular component template exists.

Index

• Variables
• type ExistsComponentTemplate
  • func New(tp elastictransport.Interface) *ExistsComponentTemplate
  • func (r ExistsComponentTemplate) Do(ctx context.Context) (bool, error)
  • func (r *ExistsComponentTemplate) ErrorTrace(errortrace bool) *ExistsComponentTemplate
  • func (r *ExistsComponentTemplate) FilterPath(filterpaths ...string) *ExistsComponentTemplate
  • func (r *ExistsComponentTemplate) Header(key, value string) *ExistsComponentTemplate
  • func (r *ExistsComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ExistsComponentTemplate) Human(human bool) *ExistsComponentTemplate
  • func (r ExistsComponentTemplate) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *ExistsComponentTemplate) Local(local bool) *ExistsComponentTemplate
  • func (r *ExistsComponentTemplate) MasterTimeout(duration string) *ExistsComponentTemplate
  • func (r ExistsComponentTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ExistsComponentTemplate) Pretty(pretty bool) *ExistsComponentTemplate
• type NewExistsComponentTemplate
  • func NewExistsComponentTemplateFunc(tp elastictransport.Interface) NewExistsComponentTemplate

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 ExistsComponentTemplate

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

func New

func New(tp elastictransport.Interface) *ExistsComponentTemplate

Check component templates. Returns information about whether a particular component template exists.

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

func (ExistsComponentTemplate) Do

func (r ExistsComponentTemplate) Do(ctx context.Context) (bool, error)

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

func (*ExistsComponentTemplate) ErrorTrace

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

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

func (*ExistsComponentTemplate) FilterPath

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

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

func (*ExistsComponentTemplate) Header

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

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

func (*ExistsComponentTemplate) HttpRequest

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

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

func (*ExistsComponentTemplate) Human

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

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 (ExistsComponentTemplate) IsSuccess

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

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

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

func (*ExistsComponentTemplate) MasterTimeout

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

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 (ExistsComponentTemplate) Perform

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

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

func (*ExistsComponentTemplate) Pretty

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

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

type NewExistsComponentTemplate

type NewExistsComponentTemplate func(name string) *ExistsComponentTemplate

NewExistsComponentTemplate type alias for index.

func NewExistsComponentTemplateFunc

func NewExistsComponentTemplateFunc(tp elastictransport.Interface) NewExistsComponentTemplate

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