Documentation
¶
Overview ¶
Get pipelines.
Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.
Index ¶
- Variables
- type GetPipeline
- func (r GetPipeline) Do(providedCtx context.Context) (Response, error)
- func (r *GetPipeline) ErrorTrace(errortrace bool) *GetPipeline
- func (r *GetPipeline) FilterPath(filterpaths ...string) *GetPipeline
- func (r *GetPipeline) Header(key, value string) *GetPipeline
- func (r *GetPipeline) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetPipeline) Human(human bool) *GetPipeline
- func (r *GetPipeline) Id(id string) *GetPipeline
- func (r GetPipeline) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetPipeline) MasterTimeout(duration string) *GetPipeline
- func (r GetPipeline) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetPipeline) Pretty(pretty bool) *GetPipeline
- func (r *GetPipeline) Summary(summary bool) *GetPipeline
- type NewGetPipeline
- type Response
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 GetPipeline ¶
type GetPipeline struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetPipeline
Get pipelines.
Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.
https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-pipeline
func (GetPipeline) Do ¶
func (r GetPipeline) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a getpipeline.Response
func (*GetPipeline) ErrorTrace ¶
func (r *GetPipeline) ErrorTrace(errortrace bool) *GetPipeline
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetPipeline) FilterPath ¶
func (r *GetPipeline) FilterPath(filterpaths ...string) *GetPipeline
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetPipeline) Header ¶
func (r *GetPipeline) Header(key, value string) *GetPipeline
Header set a key, value pair in the GetPipeline headers map.
func (*GetPipeline) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetPipeline) Human ¶
func (r *GetPipeline) Human(human bool) *GetPipeline
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 (*GetPipeline) Id ¶
func (r *GetPipeline) Id(id string) *GetPipeline
Id Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. API Name: id
func (GetPipeline) IsSuccess ¶
func (r GetPipeline) IsSuccess(providedCtx context.Context) (bool, error)
IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.
func (*GetPipeline) MasterTimeout ¶
func (r *GetPipeline) MasterTimeout(duration string) *GetPipeline
MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout
func (GetPipeline) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetPipeline) Pretty ¶
func (r *GetPipeline) Pretty(pretty bool) *GetPipeline
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
func (*GetPipeline) Summary ¶
func (r *GetPipeline) Summary(summary bool) *GetPipeline
Summary Return pipelines without their definitions (default: false) API name: summary
type NewGetPipeline ¶
type NewGetPipeline func() *GetPipeline
NewGetPipeline type alias for index.
func NewGetPipelineFunc ¶
func NewGetPipelineFunc(tp elastictransport.Interface) NewGetPipeline
NewGetPipelineFunc returns a new instance of GetPipeline with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶
type Response map[string]types.IngestPipeline
Source Files