putcomponenttemplate

package
v8.16.0 Latest Latest
Warning

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

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

Documentation

Overview

Create or update a component template. Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.

Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.

Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.

You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.

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 NewPutComponentTemplate 

type NewPutComponentTemplate func(name string) *PutComponentTemplate

NewPutComponentTemplate type alias for index.

func NewPutComponentTemplateFunc 

func NewPutComponentTemplateFunc(tp elastictransport.Interface) NewPutComponentTemplate

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

type PutComponentTemplate 

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

func New 

func New(tp elastictransport.Interface) *PutComponentTemplate

Create or update a component template. Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

An index template can be composed of multiple component templates. To use a component template, specify it in an index template’s `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template.

Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.

Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.

You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.

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

func (*PutComponentTemplate) Create 

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

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

func (*PutComponentTemplate) Deprecated added in v8.14.0 

func (r *PutComponentTemplate) Deprecated(deprecated bool) *PutComponentTemplate

Deprecated Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. API name: deprecated

func (PutComponentTemplate) Do 

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

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

func (*PutComponentTemplate) ErrorTrace added in v8.14.0 

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

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

func (*PutComponentTemplate) FilterPath added in v8.14.0 

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

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

func (*PutComponentTemplate) Header 

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

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

func (*PutComponentTemplate) HttpRequest 

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

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

func (*PutComponentTemplate) Human added in v8.14.0 

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

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 (*PutComponentTemplate) MasterTimeout 

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

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

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

Meta_ Optional user metadata about the component template. May have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset `_meta`, replace the template without specifying this information. API name: _meta

func (PutComponentTemplate) Perform added in v8.7.0 

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

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

func (*PutComponentTemplate) Pretty added in v8.14.0 

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

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

func (*PutComponentTemplate) Raw 

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

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

func (*PutComponentTemplate) Request 

func (r *PutComponentTemplate) Request(req *Request) *PutComponentTemplate

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

func (*PutComponentTemplate) Template added in v8.9.0 

func (r *PutComponentTemplate) Template(template *types.IndexState) *PutComponentTemplate

Template The template to be applied which includes mappings, settings, or aliases configuration. API name: template

func (*PutComponentTemplate) Version added in v8.9.0 

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

Version Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version. API name: version

type Request 

type Request struct {

	// Deprecated Marks this index template as deprecated. When creating or updating a
	// non-deprecated index template
	// that uses deprecated components, Elasticsearch will emit a deprecation
	// warning.
	Deprecated *bool `json:"deprecated,omitempty"`
	// Meta_ Optional user metadata about the component template.
	// May have any contents. This map is not automatically generated by
	// Elasticsearch.
	// This information is stored in the cluster state, so keeping it short is
	// preferable.
	// To unset `_meta`, replace the template without specifying this information.
	Meta_ types.Metadata `json:"_meta,omitempty"`
	// Template The template to be applied which includes mappings, settings, or aliases
	// configuration.
	Template types.IndexState `json:"template"`
	// Version Version number used to manage component templates externally.
	// This number isn't automatically generated or incremented by Elasticsearch.
	// To unset a version, replace the template without specifying a version.
	Version *int64 `json:"version,omitempty"`
}

Request holds the request body struct for the package putcomponenttemplate

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L25-L95

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

func (*Request) UnmarshalJSON added in v8.12.1 

func (s *Request) UnmarshalJSON(data []byte) error

type Response added in v8.7.0 

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 putcomponenttemplate

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/cluster/put_component_template/ClusterPutComponentTemplateResponse.ts#L22-L24

func NewResponse added in v8.7.0 

func NewResponse() *Response

NewResponse returns a Response

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.