put

Documentation

Overview

Creates or updates a query ruleset.

Index

• Variables
• type NewPut
  • func NewPutFunc(tp elastictransport.Interface) NewPut
• type Put
  • func New(tp elastictransport.Interface) *Put
  • func (r Put) Do(providedCtx context.Context) (*Response, error)
  • func (r *Put) Header(key, value string) *Put
  • func (r *Put) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Put) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Put) Raw(raw io.Reader) *Put
  • func (r *Put) Request(req *Request) *Put
  • func (r *Put) Rules(rules ...types.QueryRule) *Put
• 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 NewPut

type NewPut func(rulesetid string) *Put

NewPut type alias for index.

func NewPutFunc

func NewPutFunc(tp elastictransport.Interface) NewPut

NewPutFunc returns a new instance of Put with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Put

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

func New

func New(tp elastictransport.Interface) *Put

Creates or updates a query ruleset.

https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-ruleset.html

func (Put) Do

func (r Put) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a put.Response

func (*Put) Header

func (r *Put) Header(key, value string) *Put

Header set a key, value pair in the Put headers map.

func (*Put) HttpRequest

func (r *Put) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (Put) Perform

func (r Put) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*Put) Raw

func (r *Put) Raw(raw io.Reader) *Put

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*Put) Request

func (r *Put) Request(req *Request) *Put

Request allows to set the request property with the appropriate payload.

func (*Put) Rules

func (r *Put) Rules(rules ...types.QueryRule) *Put

API name: rules

type Request

type Request struct {
	Rules []types.QueryRule `json:"rules"`
}

Request holds the request body struct for the package put

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/query_ruleset/put/QueryRulesetPutRequest.ts#L23-L43

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 {
	Result result.Result `json:"result"`
}

Response holds the response body struct for the package put

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/query_ruleset/put/QueryRulesetPutResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response