putindextemplate

Documentation

Overview

Creates or updates an index template.

Index

• Variables
• type NewPutIndexTemplate
  • func NewPutIndexTemplateFunc(tp elastictransport.Interface) NewPutIndexTemplate
• type PutIndexTemplate
  • func New(tp elastictransport.Interface) *PutIndexTemplate
  • func (r *PutIndexTemplate) ComposedOf(composedofs ...string) *PutIndexTemplate
  • func (r *PutIndexTemplate) Create(create bool) *PutIndexTemplate
  • func (r *PutIndexTemplate) DataStream(datastream *types.DataStreamVisibility) *PutIndexTemplate
  • func (r PutIndexTemplate) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutIndexTemplate) Header(key, value string) *PutIndexTemplate
  • func (r *PutIndexTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutIndexTemplate) IndexPatterns(indices ...string) *PutIndexTemplate
  • func (r *PutIndexTemplate) Meta_(metadata types.Metadata) *PutIndexTemplate
  • func (r PutIndexTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutIndexTemplate) Priority(priority int) *PutIndexTemplate
  • func (r *PutIndexTemplate) Raw(raw io.Reader) *PutIndexTemplate
  • func (r *PutIndexTemplate) Request(req *Request) *PutIndexTemplate
  • func (r *PutIndexTemplate) Template(template *types.IndexTemplateMapping) *PutIndexTemplate
  • func (r *PutIndexTemplate) Version(versionnumber int64) *PutIndexTemplate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response

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 NewPutIndexTemplate

type NewPutIndexTemplate func(name string) *PutIndexTemplate

NewPutIndexTemplate type alias for index.

func NewPutIndexTemplateFunc

func NewPutIndexTemplateFunc(tp elastictransport.Interface) NewPutIndexTemplate

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

type PutIndexTemplate

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

func New

func New(tp elastictransport.Interface) *PutIndexTemplate

Creates or updates an index template.

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

func (*PutIndexTemplate) ComposedOf

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

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

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

Create If `true`, this request cannot replace or update existing index templates. API name: create

func (*PutIndexTemplate) DataStream

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

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

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

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

func (*PutIndexTemplate) Header

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

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

func (*PutIndexTemplate) HttpRequest

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

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

func (*PutIndexTemplate) IndexPatterns

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

IndexPatterns Name of the index template to create. API name: index_patterns

func (*PutIndexTemplate) Meta_

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

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

func (PutIndexTemplate) Perform

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

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

func (*PutIndexTemplate) Priority

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

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

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

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

func (*PutIndexTemplate) Request

func (r *PutIndexTemplate) Request(req *Request) *PutIndexTemplate

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

func (*PutIndexTemplate) Template

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

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

func (*PutIndexTemplate) Version

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

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

type Request

type Request struct {

	// 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 Name of the index template to create.
	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 putindextemplate

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L36-L95

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package putindextemplate

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/indices/put_index_template/IndicesPutIndexTemplateResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response