updatepipeline

Documentation

Overview

Update the connector pipeline.

When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

Index

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

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 NewUpdatePipeline

type NewUpdatePipeline func(connectorid string) *UpdatePipeline

NewUpdatePipeline type alias for index.

func NewUpdatePipelineFunc

func NewUpdatePipelineFunc(tp elastictransport.Interface) NewUpdatePipeline

NewUpdatePipelineFunc returns a new instance of UpdatePipeline 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 {
	Pipeline types.IngestPipelineParams `json:"pipeline"`
}

Request holds the request body struct for the package updatepipeline

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/update_pipeline/ConnectorUpdatePipelineRequest.ts#L23-L46

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 updatepipeline

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/update_pipeline/ConnectorUpdatePipelineResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdatePipeline

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

func New

func New(tp elastictransport.Interface) *UpdatePipeline

Update the connector pipeline.

When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

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

func (UpdatePipeline) Do

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

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

func (*UpdatePipeline) ErrorTrace

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

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

func (*UpdatePipeline) FilterPath

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

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

func (*UpdatePipeline) Header

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

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

func (*UpdatePipeline) HttpRequest

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

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

func (*UpdatePipeline) Human

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

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

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

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

func (*UpdatePipeline) Pipeline

func (r *UpdatePipeline) Pipeline(pipeline *types.IngestPipelineParams) *UpdatePipeline

API name: pipeline

func (*UpdatePipeline) Pretty

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

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

func (*UpdatePipeline) Raw

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

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

func (*UpdatePipeline) Request

func (r *UpdatePipeline) Request(req *Request) *UpdatePipeline

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