putcomponenttemplate

Documentation

Overview

Creates or updates a component template

Index

• Variables
• type NewPutComponentTemplate
  • func NewPutComponentTemplateFunc(tp elastictransport.Interface) NewPutComponentTemplate
• type PutComponentTemplate
  • func New(tp elastictransport.Interface) *PutComponentTemplate
  • func (r *PutComponentTemplate) AllowAutoCreate(allowautocreate bool) *PutComponentTemplate
  • func (r *PutComponentTemplate) Create(create bool) *PutComponentTemplate
  • func (r PutComponentTemplate) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutComponentTemplate) Header(key, value string) *PutComponentTemplate
  • func (r *PutComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutComponentTemplate) MasterTimeout(duration string) *PutComponentTemplate
  • func (r *PutComponentTemplate) Meta_(metadata types.Metadata) *PutComponentTemplate
  • func (r PutComponentTemplate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutComponentTemplate) Raw(raw io.Reader) *PutComponentTemplate
  • func (r *PutComponentTemplate) Request(req *Request) *PutComponentTemplate
  • func (r *PutComponentTemplate) Template(template *types.IndexState) *PutComponentTemplate
  • func (r *PutComponentTemplate) Version(versionnumber int64) *PutComponentTemplate
• 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 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

Creates or updates a component template

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

func (*PutComponentTemplate) AllowAutoCreate

func (r *PutComponentTemplate) AllowAutoCreate(allowautocreate bool) *PutComponentTemplate

AllowAutoCreate This setting overrides the value of the `action.auto_create_index` cluster setting. If set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`. If set to `false` then data streams matching the template must always be explicitly created. API name: allow_auto_create

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

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

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

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

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 {

	// AllowAutoCreate This setting overrides the value of the `action.auto_create_index` cluster
	// setting.
	// If set to `true` in a template, then indices can be automatically created
	// using that
	// template even if auto-creation of indices is disabled via
	// `actions.auto_create_index`.
	// If set to `false` then data streams matching the template must always be
	// explicitly created.
	AllowAutoCreate *bool `json:"allow_auto_create,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/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L29-L99

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 putcomponenttemplate

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response