existsindextemplate

Documentation

Overview

Returns information about whether a particular index template exists.

Index

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

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 ExistsIndexTemplate

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

func New

func New(tp elastictransport.Interface) *ExistsIndexTemplate

Returns information about whether a particular index template exists.

https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html

func (ExistsIndexTemplate) Do

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

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

func (*ExistsIndexTemplate) ErrorTrace

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

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

func (*ExistsIndexTemplate) FilterPath

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

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

func (*ExistsIndexTemplate) Header

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

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

func (*ExistsIndexTemplate) HttpRequest

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

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

func (*ExistsIndexTemplate) Human

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

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

func (r ExistsIndexTemplate) 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 (*ExistsIndexTemplate) MasterTimeout

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

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

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

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

func (*ExistsIndexTemplate) Pretty

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

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

type NewExistsIndexTemplate

type NewExistsIndexTemplate func(name string) *ExistsIndexTemplate

NewExistsIndexTemplate type alias for index.

func NewExistsIndexTemplateFunc

func NewExistsIndexTemplateFunc(tp elastictransport.Interface) NewExistsIndexTemplate

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