putbehavioralanalytics

Documentation

Overview

Create a behavioral analytics collection.

Index

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

type NewPutBehavioralAnalytics func(name string) *PutBehavioralAnalytics

NewPutBehavioralAnalytics type alias for index.

func NewPutBehavioralAnalyticsFunc

func NewPutBehavioralAnalyticsFunc(tp elastictransport.Interface) NewPutBehavioralAnalytics

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

type PutBehavioralAnalytics

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

func New

func New(tp elastictransport.Interface) *PutBehavioralAnalytics

Create a behavioral analytics collection.

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

func (PutBehavioralAnalytics) Do

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

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

func (*PutBehavioralAnalytics) ErrorTrace

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

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

func (*PutBehavioralAnalytics) FilterPath

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

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

func (*PutBehavioralAnalytics) Header

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

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

func (*PutBehavioralAnalytics) HttpRequest

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

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

func (*PutBehavioralAnalytics) Human

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

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

func (r PutBehavioralAnalytics) 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 (PutBehavioralAnalytics) Perform

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

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

func (*PutBehavioralAnalytics) Pretty

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

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

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
	// Name The name of the analytics collection created or updated
	Name string `json:"name"`
}

Response holds the response body struct for the package putbehavioralanalytics

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutResponse.ts#L23-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response