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) (*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) Perform(ctx context.Context) (*http.Response, error)
  • func (r *PutIndexTemplate) Raw(raw io.Reader) *PutIndexTemplate
  • func (r *PutIndexTemplate) Request(req *Request) *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/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) (*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) Name

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

Name Index or template name API Name: name

func (PutIndexTemplate) Perform

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

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

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.

type Request

type Request struct {
	ComposedOf    []string                    `json:"composed_of,omitempty"`
	DataStream    *types.DataStreamVisibility `json:"data_stream,omitempty"`
	IndexPatterns []string                    `json:"index_patterns,omitempty"`
	Meta_         map[string]json.RawMessage  `json:"_meta,omitempty"`
	Priority      *int                        `json:"priority,omitempty"`
	Template      *types.IndexTemplateMapping `json:"template,omitempty"`
	Version       *int64                      `json:"version,omitempty"`
}

Request holds the request body struct for the package putindextemplate

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

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response