updateconfiguration

Documentation

Overview

Updates the configuration field in the connector document

Index

• Variables
• type NewUpdateConfiguration
  • func NewUpdateConfigurationFunc(tp elastictransport.Interface) NewUpdateConfiguration
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response
• type UpdateConfiguration
  • func New(tp elastictransport.Interface) *UpdateConfiguration
  • func (r *UpdateConfiguration) Configuration(connectorconfiguration types.ConnectorConfiguration) *UpdateConfiguration
  • func (r UpdateConfiguration) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateConfiguration) ErrorTrace(errortrace bool) *UpdateConfiguration
  • func (r *UpdateConfiguration) FilterPath(filterpaths ...string) *UpdateConfiguration
  • func (r *UpdateConfiguration) Header(key, value string) *UpdateConfiguration
  • func (r *UpdateConfiguration) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateConfiguration) Human(human bool) *UpdateConfiguration
  • func (r UpdateConfiguration) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateConfiguration) Pretty(pretty bool) *UpdateConfiguration
  • func (r *UpdateConfiguration) Raw(raw io.Reader) *UpdateConfiguration
  • func (r *UpdateConfiguration) Request(req *Request) *UpdateConfiguration
  • func (r *UpdateConfiguration) Values(values map[string]json.RawMessage) *UpdateConfiguration

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 NewUpdateConfiguration

type NewUpdateConfiguration func(connectorid string) *UpdateConfiguration

NewUpdateConfiguration type alias for index.

func NewUpdateConfigurationFunc

func NewUpdateConfigurationFunc(tp elastictransport.Interface) NewUpdateConfiguration

NewUpdateConfigurationFunc returns a new instance of UpdateConfiguration 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 {
	Configuration types.ConnectorConfiguration `json:"configuration,omitempty"`
	Values        map[string]json.RawMessage   `json:"values,omitempty"`
}

Request holds the request body struct for the package updateconfiguration

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/connector/update_configuration/ConnectorUpdateConfigurationRequest.ts#L25-L47

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Result result.Result `json:"result"`
}

Response holds the response body struct for the package updateconfiguration

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

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateConfiguration

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

func New

func New(tp elastictransport.Interface) *UpdateConfiguration

Updates the configuration field in the connector document

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

func (*UpdateConfiguration) Configuration

func (r *UpdateConfiguration) Configuration(connectorconfiguration types.ConnectorConfiguration) *UpdateConfiguration

API name: configuration

func (UpdateConfiguration) Do

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

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

func (*UpdateConfiguration) ErrorTrace

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

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

func (*UpdateConfiguration) FilterPath

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

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

func (*UpdateConfiguration) Header

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

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

func (*UpdateConfiguration) HttpRequest

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

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

func (*UpdateConfiguration) Human

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

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 (UpdateConfiguration) Perform

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

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

func (*UpdateConfiguration) Pretty

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

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

func (*UpdateConfiguration) Raw

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

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

func (*UpdateConfiguration) Request

func (r *UpdateConfiguration) Request(req *Request) *UpdateConfiguration

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

func (*UpdateConfiguration) Values

func (r *UpdateConfiguration) Values(values map[string]json.RawMessage) *UpdateConfiguration

API name: values