Documentation
¶
Overview ¶
Allows to simulate a pipeline with example documents.
Index ¶
- Variables
- type NewSimulate
- type Request
- type Response
- type Simulate
- func (r Simulate) Do(providedCtx context.Context) (*Response, error)
- func (r *Simulate) Docs(docs ...types.Document) *Simulate
- func (r *Simulate) Header(key, value string) *Simulate
- func (r *Simulate) HttpRequest(ctx context.Context) (*http.Request, error)
- 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) Raw(raw io.Reader) *Simulate
- func (r *Simulate) Request(req *Request) *Simulate
- func (r *Simulate) Verbose(verbose bool) *Simulate
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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,omitempty"`
// 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
type Response ¶ added in v8.7.0
type Response struct {
Docs []types.PipelineSimulation `json:"docs"`
}
Response holds the response body struct for the package simulate
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/current/simulate-pipeline-api.html
func (Simulate) Do ¶
Do runs the request through the transport, handle the response and returns a simulate.Response
func (*Simulate) Docs ¶ added in v8.9.0
Docs Sample documents to test in the pipeline. API name: docs
func (*Simulate) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Simulate) Id ¶
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Simulate) Pipeline ¶ added in v8.9.0
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) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
Source Files