Documentation
¶
Overview ¶
Adds and updates Logstash Pipelines used for Central Management
Index ¶
- Variables
- type NewPutPipeline
- type PutPipeline
- func (r *PutPipeline) Description(description string) *PutPipeline
- func (r *PutPipeline) Header(key, value string) *PutPipeline
- func (r *PutPipeline) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PutPipeline) LastModified(datetime types.DateTime) *PutPipeline
- func (r PutPipeline) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutPipeline) Pipeline(pipeline string) *PutPipeline
- func (r *PutPipeline) PipelineMetadata(pipelinemetadata *types.PipelineMetadata) *PutPipeline
- func (r *PutPipeline) PipelineSettings(pipelinesettings *types.PipelineSettings) *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
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 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
Adds and updates Logstash Pipelines used for Central Management
https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html
func (*PutPipeline) Description ¶ added in v8.11.0
func (r *PutPipeline) Description(description string) *PutPipeline
Description Description of the pipeline. This description is not used by Elasticsearch or Logstash. API name: description
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutPipeline) LastModified ¶ added in v8.11.0
func (r *PutPipeline) LastModified(datetime types.DateTime) *PutPipeline
LastModified Date the pipeline was last updated. Must be in the `yyyy-MM-dd'T'HH:mm:ss.SSSZZ` strict_date_time format. API name: last_modified
func (PutPipeline) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PutPipeline) Pipeline ¶ added in v8.11.0
func (r *PutPipeline) Pipeline(pipeline string) *PutPipeline
Pipeline Configuration for the pipeline. API name: pipeline
func (*PutPipeline) PipelineMetadata ¶ added in v8.11.0
func (r *PutPipeline) PipelineMetadata(pipelinemetadata *types.PipelineMetadata) *PutPipeline
PipelineMetadata Optional metadata about the pipeline. May have any contents. This metadata is not generated or used by Elasticsearch or Logstash. API name: pipeline_metadata
func (*PutPipeline) PipelineSettings ¶ added in v8.11.0
func (r *PutPipeline) PipelineSettings(pipelinesettings *types.PipelineSettings) *PutPipeline
PipelineSettings Settings for the pipeline. Supports only flat keys in dot notation. API name: pipeline_settings
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 ¶ added in v8.11.0
func (r *PutPipeline) Username(username string) *PutPipeline
Username User who last updated the pipeline. API name: username
type Request ¶ added in v8.11.0
type Request = types.LogstashPipeline
Request holds the request body struct for the package putpipeline
Source Files