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) (*http.Response, error)
  • func (r *PutComponentTemplate) Header(key, value string) *PutComponentTemplate
  • func (r *PutComponentTemplate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutComponentTemplate) MasterTimeout(value string) *PutComponentTemplate
  • func (r *PutComponentTemplate) Name(v string) *PutComponentTemplate
  • func (r *PutComponentTemplate) Raw(raw json.RawMessage) *PutComponentTemplate
  • func (r *PutComponentTemplate) Request(req *Request) *PutComponentTemplate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Aliases(values map[string]*types.AliasDefinitionBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Mappings(mappings *types.TypeMappingBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Meta_(meta_ *types.MetadataBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Settings(settings *types.IndexSettingsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Template(template *types.IndexStateBuilder) *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 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) (*http.Response, error)

Do runs the http.Request through the provided transport.

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(value 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) Raw

func (r *PutComponentTemplate) Raw(raw json.RawMessage) *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 {
	Aliases map[string]types.AliasDefinition `json:"aliases,omitempty"`

	Mappings *types.TypeMapping `json:"mappings,omitempty"`

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

	Settings *types.IndexSettings `json:"settings,omitempty"`

	Template types.IndexState `json:"template"`

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

Request holds the request body struct for the package putcomponenttemplate

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/cluster/put_component_template/ClusterPutComponentTemplateRequest.ts#L29-L54

type RequestBuilder

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

RequestBuilder is the builder API for the putcomponenttemplate.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

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

func (*RequestBuilder) Aliases

func (rb *RequestBuilder) Aliases(values map[string]*types.AliasDefinitionBuilder) *RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Mappings

func (rb *RequestBuilder) Mappings(mappings *types.TypeMappingBuilder) *RequestBuilder

func (*RequestBuilder) Meta_

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

func (*RequestBuilder) Settings

func (rb *RequestBuilder) Settings(settings *types.IndexSettingsBuilder) *RequestBuilder

func (*RequestBuilder) Template

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

func (*RequestBuilder) Version

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