getindextemplate

Documentation

Overview

Get index templates. Returns information about one or more index templates.

Index

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

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

func New

func New(tp elastictransport.Interface) *GetIndexTemplate

Get index templates. Returns information about one or more index templates.

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

func (GetIndexTemplate) Do

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

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

func (*GetIndexTemplate) ErrorTrace

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

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

func (*GetIndexTemplate) FilterPath

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

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

func (*GetIndexTemplate) FlatSettings

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

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

func (*GetIndexTemplate) Header

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

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

func (*GetIndexTemplate) HttpRequest

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

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

func (*GetIndexTemplate) Human

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

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

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

IncludeDefaults If true, returns all relevant default configurations for the index template. API name: include_defaults

func (GetIndexTemplate) IsSuccess

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

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

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 (*GetIndexTemplate) MasterTimeout

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

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

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

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

func (GetIndexTemplate) Perform

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

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

func (*GetIndexTemplate) Pretty

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

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

type NewGetIndexTemplate

type NewGetIndexTemplate func() *GetIndexTemplate

NewGetIndexTemplate type alias for index.

func NewGetIndexTemplateFunc

func NewGetIndexTemplateFunc(tp elastictransport.Interface) NewGetIndexTemplate

NewGetIndexTemplateFunc returns a new instance of GetIndexTemplate 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 {
	IndexTemplates []types.IndexTemplateItem `json:"index_templates"`
}

Response holds the response body struct for the package getindextemplate

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/indices/get_index_template/IndicesGetIndexTemplateResponse.ts#L23-L27

func NewResponse

func NewResponse() *Response

NewResponse returns a Response