Documentation
¶
Overview ¶
Returns the existing behavioral analytics collections.
Index ¶
- Variables
- type GetBehavioralAnalytics
- func (r GetBehavioralAnalytics) Do(providedCtx context.Context) (Response, error)
- func (r *GetBehavioralAnalytics) Header(key, value string) *GetBehavioralAnalytics
- func (r *GetBehavioralAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
- 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)
- type NewGetBehavioralAnalytics
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type GetBehavioralAnalytics ¶
type GetBehavioralAnalytics struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetBehavioralAnalytics
Returns the existing 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) Header ¶
func (r *GetBehavioralAnalytics) Header(key, value string) *GetBehavioralAnalytics
Header set a key, value pair in the GetBehavioralAnalytics headers map.
func (*GetBehavioralAnalytics) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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
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
Source Files