Documentation ¶
Overview ¶
Deletes an index template.
Index ¶
- Variables
- type DeleteTemplate
- func (r DeleteTemplate) Do(ctx 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(ctx context.Context) (bool, error)
- func (r *DeleteTemplate) MasterTimeout(v string) *DeleteTemplate
- func (r *DeleteTemplate) Name(v string) *DeleteTemplate
- func (r DeleteTemplate) Perform(ctx context.Context) (*http.Response, error)
- func (r *DeleteTemplate) Timeout(v string) *DeleteTemplate
- type NewDeleteTemplate
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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/master/indices-templates.html
func (DeleteTemplate) Do ¶
func (r DeleteTemplate) Do(ctx 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteTemplate) IsSuccess ¶
func (r DeleteTemplate) 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 (*DeleteTemplate) MasterTimeout ¶
func (r *DeleteTemplate) MasterTimeout(v string) *DeleteTemplate
MasterTimeout Specify timeout for connection to master API name: master_timeout
func (*DeleteTemplate) Name ¶
func (r *DeleteTemplate) Name(v string) *DeleteTemplate
Name The name of the template API Name: name
func (DeleteTemplate) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteTemplate) Timeout ¶
func (r *DeleteTemplate) Timeout(v string) *DeleteTemplate
Timeout Explicit operation timeout 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.