deletetemplate

Documentation

Overview

Deletes an index template.

Index

• Variables
• type DeleteTemplate
  • func New(tp elastictransport.Interface) *DeleteTemplate
  • func (r DeleteTemplate) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteTemplate) Header(key, value string) *DeleteTemplate
  • func (r *DeleteTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteTemplate) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *DeleteTemplate) MasterTimeout(duration string) *DeleteTemplate
  • func (r DeleteTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteTemplate) Timeout(duration string) *DeleteTemplate
• type NewDeleteTemplate
  • func NewDeleteTemplateFunc(tp elastictransport.Interface) NewDeleteTemplate
• 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 DeleteTemplate

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

func New

func New(tp elastictransport.Interface) *DeleteTemplate

Deletes an index template.

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

func (DeleteTemplate) Do

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

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

func (*DeleteTemplate) Header

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

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

func (*DeleteTemplate) HttpRequest

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

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

func (DeleteTemplate) IsSuccess

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

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

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

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

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

func (*DeleteTemplate) Timeout

func (r *DeleteTemplate) Timeout(duration string) *DeleteTemplate

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

type NewDeleteTemplate

type NewDeleteTemplate func(name string) *DeleteTemplate

NewDeleteTemplate type alias for index.

func NewDeleteTemplateFunc

func NewDeleteTemplateFunc(tp elastictransport.Interface) NewDeleteTemplate

NewDeleteTemplateFunc returns a new instance of DeleteTemplate 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package deletetemplate

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/indices/delete_template/IndicesDeleteTemplateResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response