gettemplate

Documentation

Overview

Returns an index template.

Index

• Variables
• type GetTemplate
  • func New(tp elastictransport.Interface) *GetTemplate
  • func (r GetTemplate) Do(providedCtx context.Context) (Response, error)
  • func (r *GetTemplate) ErrorTrace(errortrace bool) *GetTemplate
  • func (r *GetTemplate) FilterPath(filterpaths ...string) *GetTemplate
  • func (r *GetTemplate) FlatSettings(flatsettings bool) *GetTemplate
  • func (r *GetTemplate) Header(key, value string) *GetTemplate
  • func (r *GetTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetTemplate) Human(human bool) *GetTemplate
  • func (r GetTemplate) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetTemplate) Local(local bool) *GetTemplate
  • func (r *GetTemplate) MasterTimeout(duration string) *GetTemplate
  • func (r *GetTemplate) Name(name string) *GetTemplate
  • func (r GetTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetTemplate) Pretty(pretty bool) *GetTemplate
• type NewGetTemplate
  • func NewGetTemplateFunc(tp elastictransport.Interface) NewGetTemplate
• 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 GetTemplate

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

func New

func New(tp elastictransport.Interface) *GetTemplate

Returns an index template.

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

func (GetTemplate) Do

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

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

func (*GetTemplate) ErrorTrace

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

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

func (*GetTemplate) FilterPath

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

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

func (*GetTemplate) FlatSettings

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

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

func (*GetTemplate) Header

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

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

func (*GetTemplate) HttpRequest

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

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

func (*GetTemplate) Human

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

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

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

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

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

func (*GetTemplate) MasterTimeout

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

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 (*GetTemplate) Name

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

Name Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, omit this parameter or use a value of `_all` or `*`. API Name: name

func (GetTemplate) Perform

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

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

func (*GetTemplate) Pretty

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

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

type NewGetTemplate

type NewGetTemplate func() *GetTemplate

NewGetTemplate type alias for index.

func NewGetTemplateFunc

func NewGetTemplateFunc(tp elastictransport.Interface) NewGetTemplate

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

type Response

type Response map[string]types.TemplateMapping

func NewResponse

func NewResponse() Response

NewResponse returns a Response