puttemplate

Documentation

Overview

Creates or updates an index template.

Index

• Variables
• type NewPutTemplate
  • func NewPutTemplateFunc(tp elastictransport.Interface) NewPutTemplate
• type PutTemplate
  • func New(tp elastictransport.Interface) *PutTemplate
  • func (r *PutTemplate) Aliases(aliases map[string]types.Alias) *PutTemplate
  • func (r *PutTemplate) Create(create bool) *PutTemplate
  • func (r PutTemplate) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutTemplate) FlatSettings(flatsettings bool) *PutTemplate
  • func (r *PutTemplate) Header(key, value string) *PutTemplate
  • func (r *PutTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutTemplate) IndexPatterns(indexpatterns ...string) *PutTemplate
  • func (r *PutTemplate) Mappings(mappings *types.TypeMapping) *PutTemplate
  • func (r *PutTemplate) MasterTimeout(duration string) *PutTemplate
  • func (r *PutTemplate) Order(order int) *PutTemplate
  • func (r PutTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutTemplate) Raw(raw io.Reader) *PutTemplate
  • func (r *PutTemplate) Request(req *Request) *PutTemplate
  • func (r *PutTemplate) Settings(settings map[string]json.RawMessage) *PutTemplate
  • func (r *PutTemplate) Timeout(duration string) *PutTemplate
  • func (r *PutTemplate) Version(versionnumber int64) *PutTemplate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) 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 NewPutTemplate

type NewPutTemplate func(name string) *PutTemplate

NewPutTemplate type alias for index.

func NewPutTemplateFunc

func NewPutTemplateFunc(tp elastictransport.Interface) NewPutTemplate

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

type PutTemplate

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

func New

func New(tp elastictransport.Interface) *PutTemplate

Creates or updates an index template.

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

func (*PutTemplate) Aliases

func (r *PutTemplate) Aliases(aliases map[string]types.Alias) *PutTemplate

Aliases Aliases for the index. API name: aliases

func (*PutTemplate) Create

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

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

func (PutTemplate) Do

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

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

func (*PutTemplate) FlatSettings

func (r *PutTemplate) FlatSettings(flatsettings bool) *PutTemplate

FlatSettings If `true`, returns settings in flat format. API name: flat_settings

func (*PutTemplate) Header

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

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

func (*PutTemplate) HttpRequest

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

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

func (*PutTemplate) IndexPatterns

func (r *PutTemplate) IndexPatterns(indexpatterns ...string) *PutTemplate

IndexPatterns Array of wildcard expressions used to match the names of indices during creation. API name: index_patterns

func (*PutTemplate) Mappings

func (r *PutTemplate) Mappings(mappings *types.TypeMapping) *PutTemplate

Mappings Mapping for fields in the index. API name: mappings

func (*PutTemplate) MasterTimeout

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

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 (*PutTemplate) Order

func (r *PutTemplate) Order(order int) *PutTemplate

Order Order in which Elasticsearch applies this template if index matches multiple templates.

Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values. API name: order

func (PutTemplate) Perform

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

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

func (*PutTemplate) Raw

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

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

func (*PutTemplate) Request

func (r *PutTemplate) Request(req *Request) *PutTemplate

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

func (*PutTemplate) Settings

func (r *PutTemplate) Settings(settings map[string]json.RawMessage) *PutTemplate

Settings Configuration options for the index. API name: settings

func (*PutTemplate) Timeout

func (r *PutTemplate) Timeout(duration string) *PutTemplate

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*PutTemplate) Version

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

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 {

	// Aliases Aliases for the index.
	Aliases map[string]types.Alias `json:"aliases,omitempty"`
	// IndexPatterns Array of wildcard expressions used to match the names
	// of indices during creation.
	IndexPatterns []string `json:"index_patterns,omitempty"`
	// Mappings Mapping for fields in the index.
	Mappings *types.TypeMapping `json:"mappings,omitempty"`
	// Order Order in which Elasticsearch applies this template if index
	// matches multiple templates.
	//
	// Templates with lower 'order' values are merged first. Templates with higher
	// 'order' values are merged later, overriding templates with lower values.
	Order *int `json:"order,omitempty"`
	// Settings Configuration options for the index.
	Settings map[string]json.RawMessage `json:"settings,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 puttemplate

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/put_template/IndicesPutTemplateRequest.ts#L29-L105

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

func (*Request) UnmarshalJSON

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

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 puttemplate

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/put_template/IndicesPutTemplateResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response