putpipeline

Documentation

Overview

Create or update a Logstash pipeline.

Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced.

Index

• Variables
• type NewPutPipeline
  • func NewPutPipelineFunc(tp elastictransport.Interface) NewPutPipeline
• type PutPipeline
  • func New(tp elastictransport.Interface) *PutPipeline
  • func (r *PutPipeline) Description(description string) *PutPipeline
  • func (r *PutPipeline) ErrorTrace(errortrace bool) *PutPipeline
  • func (r *PutPipeline) FilterPath(filterpaths ...string) *PutPipeline
  • func (r *PutPipeline) Header(key, value string) *PutPipeline
  • func (r *PutPipeline) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutPipeline) Human(human bool) *PutPipeline
  • func (r *PutPipeline) LastModified(datetime types.DateTimeVariant) *PutPipeline
  • func (r PutPipeline) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutPipeline) Pipeline(pipeline string) *PutPipeline
  • func (r *PutPipeline) PipelineMetadata(pipelinemetadata types.PipelineMetadataVariant) *PutPipeline
  • func (r *PutPipeline) PipelineSettings(pipelinesettings types.PipelineSettingsVariant) *PutPipeline
  • func (r *PutPipeline) Pretty(pretty bool) *PutPipeline
  • func (r *PutPipeline) Raw(raw io.Reader) *PutPipeline
  • func (r *PutPipeline) Request(req *Request) *PutPipeline
  • func (r *PutPipeline) Username(username string) *PutPipeline
• type Request
  • func NewRequest() *Request

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 NewPutPipeline

type NewPutPipeline func(id string) *PutPipeline

NewPutPipeline type alias for index.

func NewPutPipelineFunc

func NewPutPipelineFunc(tp elastictransport.Interface) NewPutPipeline

NewPutPipelineFunc returns a new instance of PutPipeline with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type PutPipeline

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

func New

func New(tp elastictransport.Interface) *PutPipeline

Create or update a Logstash pipeline.

Create a pipeline that is used for Logstash Central Management. If the specified pipeline exists, it is replaced.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-logstash-put-pipeline

func (*PutPipeline) Description

func (r *PutPipeline) Description(description string) *PutPipeline

A description of the pipeline. This description is not used by Elasticsearch or Logstash. API name: description

func (*PutPipeline) ErrorTrace

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

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

func (*PutPipeline) FilterPath

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

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

func (*PutPipeline) Header

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

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

func (*PutPipeline) HttpRequest

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

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

func (*PutPipeline) Human

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_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 (*PutPipeline) LastModified

func (r *PutPipeline) LastModified(datetime types.DateTimeVariant) *PutPipeline

The date the pipeline was last updated. It must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format. API name: last_modified

func (PutPipeline) Perform

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

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

func (*PutPipeline) Pipeline

func (r *PutPipeline) Pipeline(pipeline string) *PutPipeline

The configuration for the pipeline. API name: pipeline

func (*PutPipeline) PipelineMetadata

func (r *PutPipeline) PipelineMetadata(pipelinemetadata types.PipelineMetadataVariant) *PutPipeline

Optional metadata about the pipeline, which can have any contents. This metadata is not generated or used by Elasticsearch or Logstash. API name: pipeline_metadata

func (*PutPipeline) PipelineSettings

func (r *PutPipeline) PipelineSettings(pipelinesettings types.PipelineSettingsVariant) *PutPipeline

Settings for the pipeline. It supports only flat keys in dot notation. API name: pipeline_settings

func (*PutPipeline) Pretty

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

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

func (*PutPipeline) Raw

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

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

func (*PutPipeline) Request

func (r *PutPipeline) Request(req *Request) *PutPipeline

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

func (*PutPipeline) Username

func (r *PutPipeline) Username(username string) *PutPipeline

The user who last updated the pipeline. API name: username

type Request

type Request = types.LogstashPipeline

Request holds the request body struct for the package putpipeline

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/logstash/put_pipeline/LogstashPutPipelineRequest.ts#L24-L51

func NewRequest

func NewRequest() *Request

NewRequest returns a Request