simulate

Documentation

Overview

Allows to simulate a pipeline with example documents.

Index

• Variables
• type NewSimulate
  • func NewSimulateFunc(tp elastictransport.Interface) NewSimulate
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) Docs(docs []types.DocumentBuilder) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Pipeline(pipeline *types.PipelineBuilder) *RequestBuilder
• type Simulate
  • func New(tp elastictransport.Interface) *Simulate
  • func (r Simulate) Do(ctx context.Context) (*http.Response, error)
  • func (r *Simulate) Header(key, value string) *Simulate
  • func (r *Simulate) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Simulate) Id(v string) *Simulate
  • func (r *Simulate) Raw(raw json.RawMessage) *Simulate
  • func (r *Simulate) Request(req *Request) *Simulate
  • func (r *Simulate) Verbose(b 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 []types.Document `json:"docs,omitempty"`

	Pipeline *types.Pipeline `json:"pipeline,omitempty"`
}

Request holds the request body struct for the package simulate

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ingest/simulate/SimulatePipelineRequest.ts#L25-L41

type RequestBuilder

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

RequestBuilder is the builder API for the simulate.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) Docs

func (rb *RequestBuilder) Docs(docs []types.DocumentBuilder) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Pipeline

func (rb *RequestBuilder) Pipeline(pipeline *types.PipelineBuilder) *RequestBuilder

type Simulate

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

func New

func New(tp elastictransport.Interface) *Simulate

Allows to simulate a pipeline with example documents.

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

func (Simulate) Do

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

Do runs the http.Request through the provided transport.

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) Id

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

Id Pipeline ID API Name: id

func (*Simulate) Raw

func (r *Simulate) Raw(raw json.RawMessage) *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(b bool) *Simulate

Verbose Verbose mode. Display data output for each processor in executed pipeline API name: verbose