simulatetemplate

Documentation

Overview

Simulate resolving the given template name or body

Index

• Variables
• type NewSimulateTemplate
  • func NewSimulateTemplateFunc(tp elastictransport.Interface) NewSimulateTemplate
• type Request
• type Response
  • func NewResponse() *Response
• type SimulateTemplate
  • func New(tp elastictransport.Interface) *SimulateTemplate
  • func (r *SimulateTemplate) AllowAutoCreate(allowautocreate bool) *SimulateTemplate
  • func (r *SimulateTemplate) ComposedOf(composedofs ...string) *SimulateTemplate
  • func (r *SimulateTemplate) Create(create bool) *SimulateTemplate
  • func (r *SimulateTemplate) DataStream(datastream *types.IndexTemplateDataStreamConfiguration) *SimulateTemplate
  • func (r SimulateTemplate) Do(providedCtx context.Context) (*Response, error)
  • func (r *SimulateTemplate) Header(key, value string) *SimulateTemplate
  • func (r *SimulateTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *SimulateTemplate) IncludeDefaults(includedefaults bool) *SimulateTemplate
  • func (r *SimulateTemplate) IndexPatterns(names ...string) *SimulateTemplate
  • func (r *SimulateTemplate) MasterTimeout(duration string) *SimulateTemplate
  • func (r *SimulateTemplate) Meta_(metadata types.Metadata) *SimulateTemplate
  • func (r *SimulateTemplate) Name(name string) *SimulateTemplate
  • func (r SimulateTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *SimulateTemplate) Priority(priority int64) *SimulateTemplate
  • func (r *SimulateTemplate) Raw(raw io.Reader) *SimulateTemplate
  • func (r *SimulateTemplate) Request(req *Request) *SimulateTemplate
  • func (r *SimulateTemplate) Template(template *types.IndexTemplateSummary) *SimulateTemplate
  • func (r *SimulateTemplate) Version(versionnumber int64) *SimulateTemplate

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 NewSimulateTemplate

type NewSimulateTemplate func() *SimulateTemplate

NewSimulateTemplate type alias for index.

func NewSimulateTemplateFunc

func NewSimulateTemplateFunc(tp elastictransport.Interface) NewSimulateTemplate

NewSimulateTemplateFunc returns a new instance of SimulateTemplate with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request = types.IndexTemplate

Request holds the request body struct for the package simulatetemplate

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/indices/simulate_template/IndicesSimulateTemplateRequest.ts#L25-L61

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 simulatetemplate

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/indices/simulate_template/IndicesSimulateTemplateResponse.ts#L26-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type SimulateTemplate

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

func New

func New(tp elastictransport.Interface) *SimulateTemplate

Simulate resolving the given template name or body

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

func (*SimulateTemplate) AllowAutoCreate

func (r *SimulateTemplate) AllowAutoCreate(allowautocreate bool) *SimulateTemplate

API name: allow_auto_create

func (*SimulateTemplate) ComposedOf

func (r *SimulateTemplate) ComposedOf(composedofs ...string) *SimulateTemplate

ComposedOf An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence. API name: composed_of

func (*SimulateTemplate) Create

func (r *SimulateTemplate) Create(create bool) *SimulateTemplate

Create If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. API name: create

func (*SimulateTemplate) DataStream

func (r *SimulateTemplate) DataStream(datastream *types.IndexTemplateDataStreamConfiguration) *SimulateTemplate

DataStream If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object. API name: data_stream

func (SimulateTemplate) Do

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

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

func (*SimulateTemplate) Header

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

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

func (*SimulateTemplate) HttpRequest

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

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

func (*SimulateTemplate) IncludeDefaults

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

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

func (*SimulateTemplate) IndexPatterns

func (r *SimulateTemplate) IndexPatterns(names ...string) *SimulateTemplate

IndexPatterns Name of the index template. API name: index_patterns

func (*SimulateTemplate) MasterTimeout

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

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 (*SimulateTemplate) Meta_

func (r *SimulateTemplate) Meta_(metadata types.Metadata) *SimulateTemplate

Meta_ Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch. API name: _meta

func (*SimulateTemplate) Name

func (r *SimulateTemplate) Name(name string) *SimulateTemplate

Name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body. API Name: name

func (SimulateTemplate) Perform

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

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

func (*SimulateTemplate) Priority

func (r *SimulateTemplate) Priority(priority int64) *SimulateTemplate

Priority Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch. API name: priority

func (*SimulateTemplate) Raw

func (r *SimulateTemplate) Raw(raw io.Reader) *SimulateTemplate

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*SimulateTemplate) Request

func (r *SimulateTemplate) Request(req *Request) *SimulateTemplate

Request allows to set the request property with the appropriate payload.

func (*SimulateTemplate) Template

func (r *SimulateTemplate) Template(template *types.IndexTemplateSummary) *SimulateTemplate

Template Template to be applied. It may optionally include an `aliases`, `mappings`, or `settings` configuration. API name: template

func (*SimulateTemplate) Version

func (r *SimulateTemplate) Version(versionnumber int64) *SimulateTemplate

Version Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch. API name: version