Documentation
¶
Overview ¶
Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
Index ¶
- Variables
- type DeleteComponentTemplate
- func (r DeleteComponentTemplate) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteComponentTemplate) ErrorTrace(errortrace bool) *DeleteComponentTemplate
- func (r *DeleteComponentTemplate) FilterPath(filterpaths ...string) *DeleteComponentTemplate
- func (r *DeleteComponentTemplate) Header(key, value string) *DeleteComponentTemplate
- func (r *DeleteComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *DeleteComponentTemplate) Human(human bool) *DeleteComponentTemplate
- 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) Pretty(pretty bool) *DeleteComponentTemplate
- func (r *DeleteComponentTemplate) Timeout(duration string) *DeleteComponentTemplate
- type NewDeleteComponentTemplate
- 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 DeleteComponentTemplate ¶
type DeleteComponentTemplate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteComponentTemplate
Delete component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
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) ErrorTrace ¶
func (r *DeleteComponentTemplate) ErrorTrace(errortrace bool) *DeleteComponentTemplate
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*DeleteComponentTemplate) FilterPath ¶
func (r *DeleteComponentTemplate) FilterPath(filterpaths ...string) *DeleteComponentTemplate
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*DeleteComponentTemplate) Human ¶
func (r *DeleteComponentTemplate) Human(human bool) *DeleteComponentTemplate
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
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 ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteComponentTemplate) Pretty ¶
func (r *DeleteComponentTemplate) Pretty(pretty bool) *DeleteComponentTemplate
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
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.
Source Files