Documentation
¶
Overview ¶
Tests a Grok pattern on some text.
Index ¶
- Variables
- type NewTestGrokPattern
- type Request
- type Response
- type TestGrokPattern
- func (r TestGrokPattern) Do(providedCtx context.Context) (*Response, error)
- func (r *TestGrokPattern) EcsCompatibility(ecscompatibility 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) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *TestGrokPattern) Raw(raw io.Reader) *TestGrokPattern
- func (r *TestGrokPattern) Request(req *Request) *TestGrokPattern
- func (r *TestGrokPattern) Text(texts ...string) *TestGrokPattern
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 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 Grok pattern to run on the text.
GrokPattern string `json:"grok_pattern"`
// Text Lines of text to run the Grok pattern on.
Text []string `json:"text"`
}
Request holds the request body struct for the package testgrokpattern
type Response ¶
type Response struct {
Matches []types.MatchedText `json:"matches"`
}
Response holds the response body struct for the package testgrokpattern
type TestGrokPattern ¶
type TestGrokPattern struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *TestGrokPattern
Tests a Grok pattern on some text.
https://www.elastic.co/guide/en/elasticsearch/reference/current/test-grok-pattern.html
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 (disabled or v1, default: disabled). API name: ecs_compatibility
func (*TestGrokPattern) GrokPattern ¶
func (r *TestGrokPattern) GrokPattern(grokpattern string) *TestGrokPattern
GrokPattern 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (TestGrokPattern) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
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
Text Lines of text to run the Grok pattern on. API name: text
Source Files