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) Create(b bool) *PutIndexTemplate
  • func (r PutIndexTemplate) Do(ctx context.Context) (*http.Response, error)
  • func (r *PutIndexTemplate) Header(key, value string) *PutIndexTemplate
  • func (r *PutIndexTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutIndexTemplate) Name(v string) *PutIndexTemplate
  • func (r *PutIndexTemplate) Raw(raw json.RawMessage) *PutIndexTemplate
  • func (r *PutIndexTemplate) Request(req *Request) *PutIndexTemplate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) ComposedOf(composed_of ...types.Name) *RequestBuilder
  • func (rb *RequestBuilder) DataStream(datastream *types.DataStreamVisibilityBuilder) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) IndexPatterns(indexpatterns *types.IndicesBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Meta_(meta_ *types.MetadataBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Priority(priority int) *RequestBuilder
  • func (rb *RequestBuilder) Template(template *types.IndexTemplateMappingBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Version(version types.VersionNumber) *RequestBuilder

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/master/indices-templates.html

func (*PutIndexTemplate) Create

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

Create Whether the index template should only be added if new or can also replace an existing one API name: create

func (PutIndexTemplate) Do

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

Do runs the http.Request through the provided transport.

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) Name

func (r *PutIndexTemplate) Name(v string) *PutIndexTemplate

Name Index or template name API Name: name

func (*PutIndexTemplate) Raw

func (r *PutIndexTemplate) Raw(raw json.RawMessage) *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.

type Request

type Request struct {
	ComposedOf []types.Name `json:"composed_of,omitempty"`

	DataStream *types.DataStreamVisibility `json:"data_stream,omitempty"`

	IndexPatterns *types.Indices `json:"index_patterns,omitempty"`

	Meta_ *types.Metadata `json:"_meta,omitempty"`

	Priority *int `json:"priority,omitempty"`

	Template *types.IndexTemplateMapping `json:"template,omitempty"`

	Version *types.VersionNumber `json:"version,omitempty"`
}

Request holds the request body struct for the package putindextemplate

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/indices/put_index_template/IndicesPutIndexTemplateRequest.ts#L35-L58

type RequestBuilder

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

RequestBuilder is the builder API for the putindextemplate.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) ComposedOf

func (rb *RequestBuilder) ComposedOf(composed_of ...types.Name) *RequestBuilder

func (*RequestBuilder) DataStream

func (rb *RequestBuilder) DataStream(datastream *types.DataStreamVisibilityBuilder) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) IndexPatterns

func (rb *RequestBuilder) IndexPatterns(indexpatterns *types.IndicesBuilder) *RequestBuilder

func (*RequestBuilder) Meta_

func (rb *RequestBuilder) Meta_(meta_ *types.MetadataBuilder) *RequestBuilder

func (*RequestBuilder) Priority

func (rb *RequestBuilder) Priority(priority int) *RequestBuilder

func (*RequestBuilder) Template

func (rb *RequestBuilder) Template(template *types.IndexTemplateMappingBuilder) *RequestBuilder

func (*RequestBuilder) Version

func (rb *RequestBuilder) Version(version types.VersionNumber) *RequestBuilder