updatenative

Documentation

Overview

Updates the is_native flag in the connector document

Index

• Variables
• type NewUpdateNative
  • func NewUpdateNativeFunc(tp elastictransport.Interface) NewUpdateNative
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateNative
  • func New(tp elastictransport.Interface) *UpdateNative
  • func (r UpdateNative) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateNative) ErrorTrace(errortrace bool) *UpdateNative
  • func (r *UpdateNative) FilterPath(filterpaths ...string) *UpdateNative
  • func (r *UpdateNative) Header(key, value string) *UpdateNative
  • func (r *UpdateNative) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateNative) Human(human bool) *UpdateNative
  • func (r *UpdateNative) IsNative(isnative bool) *UpdateNative
  • func (r UpdateNative) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateNative) Pretty(pretty bool) *UpdateNative
  • func (r *UpdateNative) Raw(raw io.Reader) *UpdateNative
  • func (r *UpdateNative) Request(req *Request) *UpdateNative

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 NewUpdateNative

type NewUpdateNative func(connectorid string) *UpdateNative

NewUpdateNative type alias for index.

func NewUpdateNativeFunc

func NewUpdateNativeFunc(tp elastictransport.Interface) NewUpdateNative

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

type Request

type Request struct {
	IsNative bool `json:"is_native"`
}

Request holds the request body struct for the package updatenative

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/connector/update_native/ConnectorUpdateNativeRequest.ts#L22-L42

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 updatenative

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/connector/update_native/ConnectorUpdateNativeResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateNative

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

func New

func New(tp elastictransport.Interface) *UpdateNative

Updates the is_native flag in the connector document

https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-native-api.html

func (UpdateNative) Do

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

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

func (*UpdateNative) ErrorTrace

func (r *UpdateNative) ErrorTrace(errortrace bool) *UpdateNative

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*UpdateNative) FilterPath

func (r *UpdateNative) FilterPath(filterpaths ...string) *UpdateNative

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*UpdateNative) Header

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

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

func (*UpdateNative) HttpRequest

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

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

func (*UpdateNative) Human

func (r *UpdateNative) Human(human bool) *UpdateNative

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*UpdateNative) IsNative

func (r *UpdateNative) IsNative(isnative bool) *UpdateNative

API name: is_native

func (UpdateNative) Perform

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

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

func (*UpdateNative) Pretty

func (r *UpdateNative) Pretty(pretty bool) *UpdateNative

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*UpdateNative) Raw

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

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

func (*UpdateNative) Request

func (r *UpdateNative) Request(req *Request) *UpdateNative

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