getbehavioralanalytics

Documentation

Overview

Get behavioral analytics collections.

Index

• Variables
• type GetBehavioralAnalytics
  • func New(tp elastictransport.Interface) *GetBehavioralAnalytics
  • func (r GetBehavioralAnalytics) Do(providedCtx context.Context) (Response, error)
  • func (r *GetBehavioralAnalytics) ErrorTrace(errortrace bool) *GetBehavioralAnalytics
  • func (r *GetBehavioralAnalytics) FilterPath(filterpaths ...string) *GetBehavioralAnalytics
  • func (r *GetBehavioralAnalytics) Header(key, value string) *GetBehavioralAnalytics
  • func (r *GetBehavioralAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetBehavioralAnalytics) Human(human bool) *GetBehavioralAnalytics
  • func (r GetBehavioralAnalytics) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetBehavioralAnalytics) Name(name string) *GetBehavioralAnalytics
  • func (r GetBehavioralAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetBehavioralAnalytics) Pretty(pretty bool) *GetBehavioralAnalytics
• type NewGetBehavioralAnalytics
  • func NewGetBehavioralAnalyticsFunc(tp elastictransport.Interface) NewGetBehavioralAnalytics
• 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 GetBehavioralAnalytics

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

func New

func New(tp elastictransport.Interface) *GetBehavioralAnalytics

Get behavioral analytics collections.

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

func (GetBehavioralAnalytics) Do

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

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

func (*GetBehavioralAnalytics) ErrorTrace

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

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

func (*GetBehavioralAnalytics) FilterPath

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

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

func (*GetBehavioralAnalytics) Header

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

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

func (*GetBehavioralAnalytics) HttpRequest

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

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

func (*GetBehavioralAnalytics) Human

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

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 (GetBehavioralAnalytics) IsSuccess

func (r GetBehavioralAnalytics) 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 (*GetBehavioralAnalytics) Name

func (r *GetBehavioralAnalytics) Name(name string) *GetBehavioralAnalytics

Name A list of analytics collections to limit the returned information API Name: name

func (GetBehavioralAnalytics) Perform

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

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

func (*GetBehavioralAnalytics) Pretty

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

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

type NewGetBehavioralAnalytics

type NewGetBehavioralAnalytics func() *GetBehavioralAnalytics

NewGetBehavioralAnalytics type alias for index.

func NewGetBehavioralAnalyticsFunc

func NewGetBehavioralAnalyticsFunc(tp elastictransport.Interface) NewGetBehavioralAnalytics

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

type Response

type Response map[string]types.AnalyticsCollection

func NewResponse

func NewResponse() Response

NewResponse returns a Response