existstemplate

Documentation

Overview

Returns information about whether a particular index template exists.

Index

• Variables
• type ExistsTemplate
  • func New(tp elastictransport.Interface) *ExistsTemplate
  • func (r ExistsTemplate) Do(ctx context.Context) (*http.Response, error)
  • func (r *ExistsTemplate) FlatSettings(b bool) *ExistsTemplate
  • func (r *ExistsTemplate) Header(key, value string) *ExistsTemplate
  • func (r *ExistsTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r ExistsTemplate) IsSuccess(ctx context.Context) (bool, error)
  • func (r *ExistsTemplate) Local(b bool) *ExistsTemplate
  • func (r *ExistsTemplate) MasterTimeout(value string) *ExistsTemplate
  • func (r *ExistsTemplate) Name(v string) *ExistsTemplate
• type NewExistsTemplate
  • func NewExistsTemplateFunc(tp elastictransport.Interface) NewExistsTemplate

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 ExistsTemplate

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

func New

func New(tp elastictransport.Interface) *ExistsTemplate

Returns information about whether a particular index template exists.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html

func (ExistsTemplate) Do

func (r ExistsTemplate) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*ExistsTemplate) FlatSettings

func (r *ExistsTemplate) FlatSettings(b bool) *ExistsTemplate

FlatSettings Return settings in flat format (default: false) API name: flat_settings

func (*ExistsTemplate) Header

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

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

func (*ExistsTemplate) HttpRequest

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

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

func (ExistsTemplate) IsSuccess

func (r ExistsTemplate) IsSuccess(ctx 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 (*ExistsTemplate) Local

func (r *ExistsTemplate) Local(b bool) *ExistsTemplate

Local Return local information, do not retrieve the state from master node (default: false) API name: local

func (*ExistsTemplate) MasterTimeout

func (r *ExistsTemplate) MasterTimeout(value string) *ExistsTemplate

MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout

func (*ExistsTemplate) Name

func (r *ExistsTemplate) Name(v string) *ExistsTemplate

Name The comma separated names of the index templates API Name: name

type NewExistsTemplate

type NewExistsTemplate func(name string) *ExistsTemplate

NewExistsTemplate type alias for index.

func NewExistsTemplateFunc

func NewExistsTemplateFunc(tp elastictransport.Interface) NewExistsTemplate

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