deleteindextemplate

Documentation

Overview

Deletes an index template.

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteIndexTemplate

Deletes an index template.

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

func (DeleteIndexTemplate) Do

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

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

func (*DeleteIndexTemplate) Header

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

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

func (*DeleteIndexTemplate) HttpRequest

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

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

func (DeleteIndexTemplate) IsSuccess

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

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

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

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

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

func (*DeleteIndexTemplate) Timeout

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

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 NewDeleteIndexTemplate

type NewDeleteIndexTemplate func(name string) *DeleteIndexTemplate

NewDeleteIndexTemplate type alias for index.

func NewDeleteIndexTemplateFunc

func NewDeleteIndexTemplateFunc(tp elastictransport.Interface) NewDeleteIndexTemplate

NewDeleteIndexTemplateFunc returns a new instance of DeleteIndexTemplate 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 deleteindextemplate

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/delete_index_template/IndicesDeleteIndexTemplateResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response