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) Create(b bool) *PutComponentTemplate
  • func (r PutComponentTemplate) Do(ctx 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(v string) *PutComponentTemplate
  • func (r *PutComponentTemplate) Name(v string) *PutComponentTemplate
  • func (r PutComponentTemplate) Perform(ctx context.Context) (*http.Response, error)
  • func (r *PutComponentTemplate) Raw(raw io.Reader) *PutComponentTemplate
  • func (r *PutComponentTemplate) Request(req *Request) *PutComponentTemplate
• 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 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/{branch}/indices-component-template.html

func (*PutComponentTemplate) Create

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

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

func (PutComponentTemplate) Do

func (r PutComponentTemplate) Do(ctx 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(v string) *PutComponentTemplate

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*PutComponentTemplate) Name

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

Name The name of the template API Name: name

func (PutComponentTemplate) Perform

func (r PutComponentTemplate) Perform(ctx 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.

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.
	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.
	Version *int64 `json:"version,omitempty"`
}

Request holds the request body struct for the package putcomponenttemplate

https://github.com/elastic/elasticsearch-specification/blob/a4f7b5a7f95dad95712a6bbce449241cbb84698d/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L29-L69

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