postbehavioralanalyticsevent

Documentation

Overview

Create a behavioral analytics collection event.

Index

• Variables
• type NewPostBehavioralAnalyticsEvent
  • func NewPostBehavioralAnalyticsEventFunc(tp elastictransport.Interface) NewPostBehavioralAnalyticsEvent
• type PostBehavioralAnalyticsEvent
  • func New(tp elastictransport.Interface) *PostBehavioralAnalyticsEvent
  • func (r *PostBehavioralAnalyticsEvent) Debug(debug bool) *PostBehavioralAnalyticsEvent
  • func (r PostBehavioralAnalyticsEvent) Do(providedCtx context.Context) (*Response, error)
  • func (r *PostBehavioralAnalyticsEvent) ErrorTrace(errortrace bool) *PostBehavioralAnalyticsEvent
  • func (r *PostBehavioralAnalyticsEvent) FilterPath(filterpaths ...string) *PostBehavioralAnalyticsEvent
  • func (r *PostBehavioralAnalyticsEvent) Header(key, value string) *PostBehavioralAnalyticsEvent
  • func (r *PostBehavioralAnalyticsEvent) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PostBehavioralAnalyticsEvent) Human(human bool) *PostBehavioralAnalyticsEvent
  • func (r *PostBehavioralAnalyticsEvent) Payload(payload any) *PostBehavioralAnalyticsEvent
  • func (r PostBehavioralAnalyticsEvent) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PostBehavioralAnalyticsEvent) Pretty(pretty bool) *PostBehavioralAnalyticsEvent
  • func (r *PostBehavioralAnalyticsEvent) Raw(raw io.Reader) *PostBehavioralAnalyticsEvent
  • func (r *PostBehavioralAnalyticsEvent) Request(req any) *PostBehavioralAnalyticsEvent
• type Request
  • func NewRequest() *Request
• 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 NewPostBehavioralAnalyticsEvent

type NewPostBehavioralAnalyticsEvent func(collectionname, eventtype string) *PostBehavioralAnalyticsEvent

NewPostBehavioralAnalyticsEvent type alias for index.

func NewPostBehavioralAnalyticsEventFunc

func NewPostBehavioralAnalyticsEventFunc(tp elastictransport.Interface) NewPostBehavioralAnalyticsEvent

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

type PostBehavioralAnalyticsEvent

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

func New

func New(tp elastictransport.Interface) *PostBehavioralAnalyticsEvent

Create a behavioral analytics collection event.

https://www.elastic.co/guide/en/elasticsearch/reference/current/post-analytics-collection-event.html

func (*PostBehavioralAnalyticsEvent) Debug

func (r *PostBehavioralAnalyticsEvent) Debug(debug bool) *PostBehavioralAnalyticsEvent

Debug Whether the response type has to include more details API name: debug

func (PostBehavioralAnalyticsEvent) Do

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

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

func (*PostBehavioralAnalyticsEvent) ErrorTrace

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

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

func (*PostBehavioralAnalyticsEvent) FilterPath

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

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

func (*PostBehavioralAnalyticsEvent) Header

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

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

func (*PostBehavioralAnalyticsEvent) HttpRequest

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

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

func (*PostBehavioralAnalyticsEvent) Human

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

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 (*PostBehavioralAnalyticsEvent) Payload

func (r *PostBehavioralAnalyticsEvent) Payload(payload any) *PostBehavioralAnalyticsEvent

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

func (PostBehavioralAnalyticsEvent) Perform

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

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

func (*PostBehavioralAnalyticsEvent) Pretty

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

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

func (*PostBehavioralAnalyticsEvent) Raw

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

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

func (*PostBehavioralAnalyticsEvent) Request

func (r *PostBehavioralAnalyticsEvent) Request(req any) *PostBehavioralAnalyticsEvent

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

type Request

type Request = json.RawMessage

Request holds the request body struct for the package postbehavioralanalyticsevent

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostRequest.ts#L24-L57

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

type Response

type Response struct {
	Accepted bool            `json:"accepted"`
	Event    json.RawMessage `json:"event,omitempty"`
}

Response holds the response body struct for the package postbehavioralanalyticsevent

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/search_application/post_behavioral_analytics_event/BehavioralAnalyticsEventPostResponse.ts#L22-L47

func NewResponse

func NewResponse() *Response

NewResponse returns a Response