deletecomponenttemplate

Documentation

Overview

Deletes a component template

Index

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

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

func New

func New(tp elastictransport.Interface) *DeleteComponentTemplate

Deletes a component template

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

func (DeleteComponentTemplate) Do

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

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

func (*DeleteComponentTemplate) Header

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

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

func (*DeleteComponentTemplate) HttpRequest

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

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

func (DeleteComponentTemplate) IsSuccess

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

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

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

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

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

func (*DeleteComponentTemplate) Timeout

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

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 NewDeleteComponentTemplate

type NewDeleteComponentTemplate func(name string) *DeleteComponentTemplate

NewDeleteComponentTemplate type alias for index.

func NewDeleteComponentTemplateFunc

func NewDeleteComponentTemplateFunc(tp elastictransport.Interface) NewDeleteComponentTemplate

NewDeleteComponentTemplateFunc returns a new instance of DeleteComponentTemplate 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 deletecomponenttemplate

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/cluster/delete_component_template/ClusterDeleteComponentTemplateResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response