simulate

Documentation

Overview

Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.

Index

• Variables
• type NewSimulate
  • func NewSimulateFunc(tp elastictransport.Interface) NewSimulate
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type Simulate
  • func New(tp elastictransport.Interface) *Simulate
  • func (r Simulate) Do(providedCtx context.Context) (*Response, error)
  • func (r *Simulate) Docs(docs ...types.Document) *Simulate
  • func (r *Simulate) ErrorTrace(errortrace bool) *Simulate
  • func (r *Simulate) FilterPath(filterpaths ...string) *Simulate
  • func (r *Simulate) Header(key, value string) *Simulate
  • func (r *Simulate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Simulate) Human(human bool) *Simulate
  • func (r *Simulate) Id(id string) *Simulate
  • func (r Simulate) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Simulate) Pipeline(pipeline *types.IngestPipeline) *Simulate
  • func (r *Simulate) Pretty(pretty bool) *Simulate
  • func (r *Simulate) Raw(raw io.Reader) *Simulate
  • func (r *Simulate) Request(req *Request) *Simulate
  • func (r *Simulate) Verbose(verbose bool) *Simulate

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 NewSimulate

type NewSimulate func() *Simulate

NewSimulate type alias for index.

func NewSimulateFunc

func NewSimulateFunc(tp elastictransport.Interface) NewSimulate

NewSimulateFunc returns a new instance of Simulate 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 {

	// Docs Sample documents to test in the pipeline.
	Docs []types.Document `json:"docs"`
	// Pipeline Pipeline to test.
	// If you don’t specify the `pipeline` request path parameter, this parameter is
	// required.
	// If you specify both this and the request path parameter, the API only uses
	// the request path parameter.
	Pipeline *types.IngestPipeline `json:"pipeline,omitempty"`
}

Request holds the request body struct for the package simulate

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ingest/simulate/SimulatePipelineRequest.ts#L25-L59

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 {
	Docs []types.SimulateDocumentResult `json:"docs"`
}

Response holds the response body struct for the package simulate

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ingest/simulate/SimulatePipelineResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Simulate

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

func New

func New(tp elastictransport.Interface) *Simulate

Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.

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

func (Simulate) Do

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

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

func (*Simulate) Docs

func (r *Simulate) Docs(docs ...types.Document) *Simulate

Docs Sample documents to test in the pipeline. API name: docs

func (*Simulate) ErrorTrace

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

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

func (*Simulate) FilterPath

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

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

func (*Simulate) Header

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

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

func (*Simulate) HttpRequest

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

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

func (*Simulate) Human

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

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 (*Simulate) Id

func (r *Simulate) Id(id string) *Simulate

Id Pipeline to test. If you don’t specify a `pipeline` in the request body, this parameter is required. API Name: id

func (Simulate) Perform

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

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

func (*Simulate) Pipeline

func (r *Simulate) Pipeline(pipeline *types.IngestPipeline) *Simulate

Pipeline Pipeline to test. If you don’t specify the `pipeline` request path parameter, this parameter is required. If you specify both this and the request path parameter, the API only uses the request path parameter. API name: pipeline

func (*Simulate) Pretty

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

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

func (*Simulate) Raw

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

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

func (*Simulate) Request

func (r *Simulate) Request(req *Request) *Simulate

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

func (*Simulate) Verbose

func (r *Simulate) Verbose(verbose bool) *Simulate

Verbose If `true`, the response includes output data for each processor in the executed pipeline. API name: verbose