Documentation ¶
Overview ¶
Creates or updates a component template
Index ¶
- Variables
- type NewPutComponentTemplate
- type 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
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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) Header ¶
func (r *PutComponentTemplate) Header(key, value string) *PutComponentTemplate
Header set a key, value pair in the PutComponentTemplate headers map.
func (*PutComponentTemplate) HttpRequest ¶
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_ map[string]interface{} `json:"_meta,omitempty"` Settings *types.IndexSettings `json:"settings,omitempty"` Template types.IndexState `json:"template"` Version *int64 `json:"version,omitempty"` }
Request holds the request body struct for the package putcomponenttemplate