simulateindextemplate

package
v8.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 27, 2023 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Simulate matching the given index name against the index templates in the system

Index

Constants

This section is empty.

Variables

View Source 
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 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 Request 

type Request struct {

	// AllowAutoCreate This setting overrides the value of the `action.auto_create_index` cluster
	// setting.
	// If set to `true` in a template, then indices can be automatically created
	// using that template even if auto-creation of indices is disabled via
	// `actions.auto_create_index`.
	// If set to `false`, then indices or data streams matching the template must
	// always be explicitly created, and may never be automatically created.
	AllowAutoCreate *bool `json:"allow_auto_create,omitempty"`
	// 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.
	ComposedOf []string `json:"composed_of,omitempty"`
	// 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.
	DataStream *types.DataStreamVisibility `json:"data_stream,omitempty"`
	// IndexPatterns Array of wildcard (`*`) expressions used to match the names of data streams
	// and indices during creation.
	IndexPatterns []string `json:"index_patterns,omitempty"`
	// Meta_ Optional user metadata about the index template.
	// May have any contents.
	// This map is not automatically generated by Elasticsearch.
	Meta_ types.Metadata `json:"_meta,omitempty"`
	// 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.
	Priority *int `json:"priority,omitempty"`
	// Template Template to be applied.
	// It may optionally include an `aliases`, `mappings`, or `settings`
	// configuration.
	Template *types.IndexTemplateMapping `json:"template,omitempty"`
	// Version Version number used to manage index templates externally.
	// This number is not automatically generated by Elasticsearch.
	Version *int64 `json:"version,omitempty"`
}

Request holds the request body struct for the package simulateindextemplate

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateRequest.ts#L33-L115

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0 

type Response struct {
}

Response holds the response body struct for the package simulateindextemplate

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/indices/simulate_index_template/IndicesSimulateIndexTemplateResponse.ts#L20-L22

func NewResponse added in v8.7.0 

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 matching the given index name against the index templates in the system

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

func (*SimulateIndexTemplate) AllowAutoCreate added in v8.9.0 

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

AllowAutoCreate This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created. API name: allow_auto_create

func (*SimulateIndexTemplate) ComposedOf added in v8.9.0 

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

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

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

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 (*SimulateIndexTemplate) DataStream added in v8.9.0 

func (r *SimulateIndexTemplate) DataStream(datastream *types.DataStreamVisibility) *SimulateIndexTemplate

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

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

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

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) IncludeDefaults added in v8.8.0 

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) IndexPatterns added in v8.9.0 

func (r *SimulateIndexTemplate) IndexPatterns(indices ...string) *SimulateIndexTemplate

IndexPatterns Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation. API name: index_patterns

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) Meta_ added in v8.9.0 

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

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

func (SimulateIndexTemplate) Perform added in v8.7.0 

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

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

func (*SimulateIndexTemplate) Priority added in v8.9.0 

func (r *SimulateIndexTemplate) Priority(priority int) *SimulateIndexTemplate

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

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

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

func (*SimulateIndexTemplate) Request 

func (r *SimulateIndexTemplate) Request(req *Request) *SimulateIndexTemplate

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

func (*SimulateIndexTemplate) Template added in v8.9.0 

func (r *SimulateIndexTemplate) Template(template *types.IndexTemplateMapping) *SimulateIndexTemplate

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

func (*SimulateIndexTemplate) Version added in v8.9.0 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.