testgrokpattern

Documentation

Overview

Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

Index

• Variables
• type NewTestGrokPattern
  • func NewTestGrokPatternFunc(tp elastictransport.Interface) NewTestGrokPattern
• 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
• type TestGrokPattern
  • func New(tp elastictransport.Interface) *TestGrokPattern
  • func (r TestGrokPattern) Do(providedCtx context.Context) (*Response, error)
  • func (r *TestGrokPattern) EcsCompatibility(ecscompatibility string) *TestGrokPattern
  • func (r *TestGrokPattern) ErrorTrace(errortrace bool) *TestGrokPattern
  • func (r *TestGrokPattern) FilterPath(filterpaths ...string) *TestGrokPattern
  • func (r *TestGrokPattern) GrokPattern(grokpattern string) *TestGrokPattern
  • func (r *TestGrokPattern) Header(key, value string) *TestGrokPattern
  • func (r *TestGrokPattern) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *TestGrokPattern) Human(human bool) *TestGrokPattern
  • func (r TestGrokPattern) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *TestGrokPattern) Pretty(pretty bool) *TestGrokPattern
  • func (r *TestGrokPattern) Raw(raw io.Reader) *TestGrokPattern
  • func (r *TestGrokPattern) Request(req *Request) *TestGrokPattern
  • func (r *TestGrokPattern) Text(texts ...string) *TestGrokPattern

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 NewTestGrokPattern

type NewTestGrokPattern func() *TestGrokPattern

NewTestGrokPattern type alias for index.

func NewTestGrokPatternFunc

func NewTestGrokPatternFunc(tp elastictransport.Interface) NewTestGrokPattern

NewTestGrokPatternFunc returns a new instance of TestGrokPattern 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 {

	// GrokPattern The Grok pattern to run on the text.
	GrokPattern string `json:"grok_pattern"`
	// Text The lines of text to run the Grok pattern on.
	Text []string `json:"text"`
}

Request holds the request body struct for the package testgrokpattern

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/text_structure/test_grok_pattern/TestGrokPatternRequest.ts#L23-L59

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 {
	Matches []types.MatchedText `json:"matches"`
}

Response holds the response body struct for the package testgrokpattern

https://github.com/elastic/elasticsearch-specification/blob/52c473efb1fb5320a5bac12572d0b285882862fb/specification/text_structure/test_grok_pattern/TestGrokPatternResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type TestGrokPattern

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

func New

func New(tp elastictransport.Interface) *TestGrokPattern

Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-test-grok-pattern

func (TestGrokPattern) Do

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

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

func (*TestGrokPattern) EcsCompatibility

func (r *TestGrokPattern) EcsCompatibility(ecscompatibility string) *TestGrokPattern

EcsCompatibility The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are `disabled` and `v1`. API name: ecs_compatibility

func (*TestGrokPattern) ErrorTrace

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

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

func (*TestGrokPattern) FilterPath

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

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

func (*TestGrokPattern) GrokPattern

func (r *TestGrokPattern) GrokPattern(grokpattern string) *TestGrokPattern

The Grok pattern to run on the text. API name: grok_pattern

func (*TestGrokPattern) Header

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

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

func (*TestGrokPattern) HttpRequest

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

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

func (*TestGrokPattern) Human

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

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 (TestGrokPattern) Perform

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

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

func (*TestGrokPattern) Pretty

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

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

func (*TestGrokPattern) Raw

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

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

func (*TestGrokPattern) Request

func (r *TestGrokPattern) Request(req *Request) *TestGrokPattern

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

func (*TestGrokPattern) Text

func (r *TestGrokPattern) Text(texts ...string) *TestGrokPattern

The lines of text to run the Grok pattern on. API name: text