findmessagestructure

Documentation

Overview

Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

Index

• Variables
• type FindMessageStructure
  • func New(tp elastictransport.Interface) *FindMessageStructure
  • func (r FindMessageStructure) Do(ctx context.Context) (bool, error)
  • func (r *FindMessageStructure) Header(key, value string) *FindMessageStructure
  • func (r *FindMessageStructure) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r FindMessageStructure) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r FindMessageStructure) Perform(providedCtx context.Context) (*http.Response, error)
• type NewFindMessageStructure
  • func NewFindMessageStructureFunc(tp elastictransport.Interface) NewFindMessageStructure

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 FindMessageStructure

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

func New

func New(tp elastictransport.Interface) *FindMessageStructure

Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch.

https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html

func (FindMessageStructure) Do

func (r FindMessageStructure) Do(ctx context.Context) (bool, error)

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

func (*FindMessageStructure) Header

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

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

func (*FindMessageStructure) HttpRequest

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

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

func (FindMessageStructure) IsSuccess

func (r FindMessageStructure) IsSuccess(providedCtx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (FindMessageStructure) Perform

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

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

type NewFindMessageStructure

type NewFindMessageStructure func() *FindMessageStructure

NewFindMessageStructure type alias for index.

func NewFindMessageStructureFunc

func NewFindMessageStructureFunc(tp elastictransport.Interface) NewFindMessageStructure

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