Documentation
¶
Overview ¶
Check existence of index templates. Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
Index ¶
- Variables
- type ExistsTemplate
- func (r ExistsTemplate) Do(ctx context.Context) (bool, error)
- func (r *ExistsTemplate) ErrorTrace(errortrace bool) *ExistsTemplate
- func (r *ExistsTemplate) FilterPath(filterpaths ...string) *ExistsTemplate
- func (r *ExistsTemplate) FlatSettings(flatsettings bool) *ExistsTemplate
- func (r *ExistsTemplate) Header(key, value string) *ExistsTemplate
- func (r *ExistsTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ExistsTemplate) Human(human bool) *ExistsTemplate
- func (r ExistsTemplate) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *ExistsTemplate) Local(local bool) *ExistsTemplate
- func (r *ExistsTemplate) MasterTimeout(duration string) *ExistsTemplate
- func (r ExistsTemplate) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ExistsTemplate) Pretty(pretty bool) *ExistsTemplate
- type NewExistsTemplate
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 ExistsTemplate ¶
type ExistsTemplate struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ExistsTemplate
Check existence of index templates. Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-template-exists-v1.html
func (ExistsTemplate) Do ¶
func (r ExistsTemplate) Do(ctx context.Context) (bool, error)
Do runs the request through the transport, handle the response and returns a existstemplate.Response
func (*ExistsTemplate) ErrorTrace ¶ added in v8.14.0
func (r *ExistsTemplate) ErrorTrace(errortrace bool) *ExistsTemplate
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*ExistsTemplate) FilterPath ¶ added in v8.14.0
func (r *ExistsTemplate) FilterPath(filterpaths ...string) *ExistsTemplate
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*ExistsTemplate) FlatSettings ¶
func (r *ExistsTemplate) FlatSettings(flatsettings bool) *ExistsTemplate
FlatSettings Indicates whether to use a flat format for the response. API name: flat_settings
func (*ExistsTemplate) Header ¶
func (r *ExistsTemplate) Header(key, value string) *ExistsTemplate
Header set a key, value pair in the ExistsTemplate headers map.
func (*ExistsTemplate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ExistsTemplate) Human ¶ added in v8.14.0
func (r *ExistsTemplate) Human(human bool) *ExistsTemplate
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 (ExistsTemplate) IsSuccess ¶
func (r ExistsTemplate) 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 (*ExistsTemplate) Local ¶
func (r *ExistsTemplate) Local(local bool) *ExistsTemplate
Local Indicates whether to get information from the local node only. API name: local
func (*ExistsTemplate) MasterTimeout ¶
func (r *ExistsTemplate) MasterTimeout(duration string) *ExistsTemplate
MasterTimeout The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. API name: master_timeout
func (ExistsTemplate) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ExistsTemplate) Pretty ¶ added in v8.14.0
func (r *ExistsTemplate) Pretty(pretty bool) *ExistsTemplate
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewExistsTemplate ¶
type NewExistsTemplate func(name string) *ExistsTemplate
NewExistsTemplate type alias for index.
func NewExistsTemplateFunc ¶
func NewExistsTemplateFunc(tp elastictransport.Interface) NewExistsTemplate
NewExistsTemplateFunc returns a new instance of ExistsTemplate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files
