updatefeatures

Documentation

Overview

Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector:

* document-level security * incremental syncs * advanced sync rules * basic sync rules

Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

Index

• Variables
• type NewUpdateFeatures
  • func NewUpdateFeaturesFunc(tp elastictransport.Interface) NewUpdateFeatures
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateFeatures
  • func New(tp elastictransport.Interface) *UpdateFeatures
  • func (r UpdateFeatures) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateFeatures) ErrorTrace(errortrace bool) *UpdateFeatures
  • func (r *UpdateFeatures) Features(features *types.ConnectorFeatures) *UpdateFeatures
  • func (r *UpdateFeatures) FilterPath(filterpaths ...string) *UpdateFeatures
  • func (r *UpdateFeatures) Header(key, value string) *UpdateFeatures
  • func (r *UpdateFeatures) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateFeatures) Human(human bool) *UpdateFeatures
  • func (r UpdateFeatures) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateFeatures) Pretty(pretty bool) *UpdateFeatures
  • func (r *UpdateFeatures) Raw(raw io.Reader) *UpdateFeatures
  • func (r *UpdateFeatures) Request(req *Request) *UpdateFeatures

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 NewUpdateFeatures

type NewUpdateFeatures func(connectorid string) *UpdateFeatures

NewUpdateFeatures type alias for index.

func NewUpdateFeaturesFunc

func NewUpdateFeaturesFunc(tp elastictransport.Interface) NewUpdateFeatures

NewUpdateFeaturesFunc returns a new instance of UpdateFeatures 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 {
	Features types.ConnectorFeatures `json:"features"`
}

Request holds the request body struct for the package updatefeatures

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/connector/update_features/ConnectorUpdateFeaturesRequest.ts#L23-L61

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 updatefeatures

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/connector/update_features/ConnectorUpdateFeaturesResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateFeatures

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

func New

func New(tp elastictransport.Interface) *UpdateFeatures

Update the connector features. Update the connector features in the connector document. This API can be used to control the following aspects of a connector:

* document-level security * incremental syncs * advanced sync rules * basic sync rules

Normally, the running connector service automatically manages these features. However, you can use this API to override the default behavior.

To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

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

func (UpdateFeatures) Do

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

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

func (*UpdateFeatures) ErrorTrace

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

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

func (*UpdateFeatures) Features

func (r *UpdateFeatures) Features(features *types.ConnectorFeatures) *UpdateFeatures

API name: features

func (*UpdateFeatures) FilterPath

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

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

func (*UpdateFeatures) Header

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

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

func (*UpdateFeatures) HttpRequest

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

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

func (*UpdateFeatures) Human

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

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

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

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

func (*UpdateFeatures) Pretty

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

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

func (*UpdateFeatures) Raw

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

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

func (*UpdateFeatures) Request

func (r *UpdateFeatures) Request(req *Request) *UpdateFeatures

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