simulateindextemplate

Documentation

Overview

Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template.

Index

• Variables
• type NewSimulateIndexTemplate
  • func NewSimulateIndexTemplateFunc(tp elastictransport.Interface) NewSimulateIndexTemplate
• type Response
  • func NewResponse() *Response
• type SimulateIndexTemplate
  • func New(tp elastictransport.Interface) *SimulateIndexTemplate
  • func (r SimulateIndexTemplate) Do(providedCtx context.Context) (*Response, error)
  • func (r *SimulateIndexTemplate) ErrorTrace(errortrace bool) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) FilterPath(filterpaths ...string) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) Header(key, value string) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SimulateIndexTemplate) Human(human bool) *SimulateIndexTemplate
  • func (r *SimulateIndexTemplate) IncludeDefaults(includedefaults bool) *SimulateIndexTemplate
  • func (r SimulateIndexTemplate) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *SimulateIndexTemplate) MasterTimeout(duration string) *SimulateIndexTemplate
  • func (r SimulateIndexTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SimulateIndexTemplate) Pretty(pretty bool) *SimulateIndexTemplate

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 NewSimulateIndexTemplate

type NewSimulateIndexTemplate func(name string) *SimulateIndexTemplate

NewSimulateIndexTemplate type alias for index.

func NewSimulateIndexTemplateFunc

func NewSimulateIndexTemplateFunc(tp elastictransport.Interface) NewSimulateIndexTemplate

NewSimulateIndexTemplateFunc returns a new instance of SimulateIndexTemplate 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 {
	Overlapping []types.Overlapping `json:"overlapping,omitempty"`
	Template    types.Template      `json:"template"`
}

Response holds the response body struct for the package simulateindextemplate

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateResponse.ts#L25-L30

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SimulateIndexTemplate

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

func New

func New(tp elastictransport.Interface) *SimulateIndexTemplate

Simulate an index. Returns the index configuration that would be applied to the specified index from an existing index template.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-simulate-index.html

func (SimulateIndexTemplate) Do

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

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

func (*SimulateIndexTemplate) ErrorTrace

func (r *SimulateIndexTemplate) ErrorTrace(errortrace bool) *SimulateIndexTemplate

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*SimulateIndexTemplate) FilterPath

func (r *SimulateIndexTemplate) FilterPath(filterpaths ...string) *SimulateIndexTemplate

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*SimulateIndexTemplate) Header

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

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

func (*SimulateIndexTemplate) HttpRequest

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

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

func (*SimulateIndexTemplate) Human

func (r *SimulateIndexTemplate) Human(human bool) *SimulateIndexTemplate

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 (*SimulateIndexTemplate) IncludeDefaults

func (r *SimulateIndexTemplate) IncludeDefaults(includedefaults bool) *SimulateIndexTemplate

IncludeDefaults If true, returns all relevant default configurations for the index template. API name: include_defaults

func (SimulateIndexTemplate) IsSuccess

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

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

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

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

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

func (*SimulateIndexTemplate) Pretty

func (r *SimulateIndexTemplate) Pretty(pretty bool) *SimulateIndexTemplate

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty