putbehavioralanalytics

Documentation

Overview

Creates 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(ctx context.Context) (*Response, error)
  • func (r *PutBehavioralAnalytics) Header(key, value string) *PutBehavioralAnalytics
  • func (r *PutBehavioralAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r PutBehavioralAnalytics) IsSuccess(ctx context.Context) (bool, error)
  • func (r PutBehavioralAnalytics) Perform(ctx context.Context) (*http.Response, error)
• 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

Creates a behavioral analytics collection.

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

func (PutBehavioralAnalytics) Do

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

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

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

func (r PutBehavioralAnalytics) IsSuccess(ctx 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(ctx context.Context) (*http.Response, error)

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

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/5fea44e006349579bf3561a82e997002e5716117/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutResponse.ts#L24-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response