putpipeline

Documentation

Overview

Creates or updates a pipeline.

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) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutPipeline) Header(key, value string) *PutPipeline
  • func (r *PutPipeline) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutPipeline) IfVersion(versionnumber string) *PutPipeline
  • func (r *PutPipeline) MasterTimeout(duration string) *PutPipeline
  • func (r *PutPipeline) Meta_(metadata types.Metadata) *PutPipeline
  • func (r *PutPipeline) OnFailure(onfailures ...types.ProcessorContainer) *PutPipeline
  • func (r PutPipeline) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutPipeline) Processors(processors ...types.ProcessorContainer) *PutPipeline
  • func (r *PutPipeline) Raw(raw io.Reader) *PutPipeline
  • func (r *PutPipeline) Request(req *Request) *PutPipeline
  • func (r *PutPipeline) Timeout(duration string) *PutPipeline
  • func (r *PutPipeline) Version(versionnumber int64) *PutPipeline
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response

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

Creates or updates a pipeline.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest.html

func (*PutPipeline) Description

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

Description Description of the ingest pipeline. API name: description

func (PutPipeline) Do

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

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

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

func (r *PutPipeline) IfVersion(versionnumber string) *PutPipeline

IfVersion Required version for optimistic concurrency control for pipeline updates API name: if_version

func (*PutPipeline) MasterTimeout

func (r *PutPipeline) MasterTimeout(duration string) *PutPipeline

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 (*PutPipeline) Meta_

func (r *PutPipeline) Meta_(metadata types.Metadata) *PutPipeline

Meta_ Optional metadata about the ingest pipeline. May have any contents. This map is not automatically generated by Elasticsearch. API name: _meta

func (*PutPipeline) OnFailure

func (r *PutPipeline) OnFailure(onfailures ...types.ProcessorContainer) *PutPipeline

OnFailure Processors to run immediately after a processor failure. Each processor supports a processor-level `on_failure` value. If a processor without an `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline's remaining processors. API name: on_failure

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

func (r *PutPipeline) Processors(processors ...types.ProcessorContainer) *PutPipeline

Processors Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. API name: processors

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

func (r *PutPipeline) Timeout(duration string) *PutPipeline

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*PutPipeline) Version

func (r *PutPipeline) Version(versionnumber int64) *PutPipeline

Version Version number used by external systems to track ingest pipelines. This parameter is intended for external systems only. Elasticsearch does not use or validate pipeline version numbers. API name: version

type Request

type Request struct {

	// Description Description of the ingest pipeline.
	Description *string `json:"description,omitempty"`
	// Meta_ Optional metadata about the ingest pipeline. May have any contents. This map
	// is not automatically generated by Elasticsearch.
	Meta_ types.Metadata `json:"_meta,omitempty"`
	// OnFailure Processors to run immediately after a processor failure. Each processor
	// supports a processor-level `on_failure` value. If a processor without an
	// `on_failure` value fails, Elasticsearch uses this pipeline-level parameter as
	// a fallback. The processors in this parameter run sequentially in the order
	// specified. Elasticsearch will not attempt to run the pipeline's remaining
	// processors.
	OnFailure []types.ProcessorContainer `json:"on_failure,omitempty"`
	// Processors Processors used to perform transformations on documents before indexing.
	// Processors run sequentially in the order specified.
	Processors []types.ProcessorContainer `json:"processors,omitempty"`
	// Version Version number used by external systems to track ingest pipelines. This
	// parameter is intended for external systems only. Elasticsearch does not use
	// or validate pipeline version numbers.
	Version *int64 `json:"version,omitempty"`
}

Request holds the request body struct for the package putpipeline

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ingest/put_pipeline/PutPipelineRequest.ts#L25-L77

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package putpipeline

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ingest/put_pipeline/PutPipelineResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response