Documentation
¶
Overview ¶
Retrieves anomaly detection job results for one or more categories.
Index ¶
- Variables
- type GetCategories
- func (r *GetCategories) CategoryId(categoryid string) *GetCategories
- func (r GetCategories) Do(providedCtx context.Context) (*Response, error)
- func (r *GetCategories) From(from int) *GetCategories
- func (r *GetCategories) Header(key, value string) *GetCategories
- func (r *GetCategories) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetCategories) Page(page *types.Page) *GetCategories
- func (r *GetCategories) PartitionFieldValue(partitionfieldvalue string) *GetCategories
- func (r GetCategories) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetCategories) Raw(raw io.Reader) *GetCategories
- func (r *GetCategories) Request(req *Request) *GetCategories
- func (r *GetCategories) Size(size int) *GetCategories
- type NewGetCategories
- type Request
- 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 GetCategories ¶
type GetCategories struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetCategories
Retrieves anomaly detection job results for one or more categories.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html
func (*GetCategories) CategoryId ¶
func (r *GetCategories) CategoryId(categoryid string) *GetCategories
CategoryId Identifier for the category, which is unique in the job. If you specify neither the category ID nor the partition_field_value, the API returns information about all categories. If you specify only the partition_field_value, it returns information about all categories for the specified partition. API Name: categoryid
func (GetCategories) Do ¶
func (r GetCategories) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getcategories.Response
func (*GetCategories) From ¶
func (r *GetCategories) From(from int) *GetCategories
From Skips the specified number of categories. API name: from
func (*GetCategories) Header ¶
func (r *GetCategories) Header(key, value string) *GetCategories
Header set a key, value pair in the GetCategories headers map.
func (*GetCategories) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetCategories) Page ¶ added in v8.9.0
func (r *GetCategories) Page(page *types.Page) *GetCategories
Page Configures pagination. This parameter has the `from` and `size` properties. API name: page
func (*GetCategories) PartitionFieldValue ¶
func (r *GetCategories) PartitionFieldValue(partitionfieldvalue string) *GetCategories
PartitionFieldValue Only return categories for the specified partition. API name: partition_field_value
func (GetCategories) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetCategories) Raw ¶
func (r *GetCategories) Raw(raw io.Reader) *GetCategories
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*GetCategories) Request ¶
func (r *GetCategories) Request(req *Request) *GetCategories
Request allows to set the request property with the appropriate payload.
func (*GetCategories) Size ¶
func (r *GetCategories) Size(size int) *GetCategories
Size Specifies the maximum number of categories to obtain. API name: size
type NewGetCategories ¶
type NewGetCategories func(jobid string) *GetCategories
NewGetCategories type alias for index.
func NewGetCategoriesFunc ¶
func NewGetCategoriesFunc(tp elastictransport.Interface) NewGetCategories
NewGetCategoriesFunc returns a new instance of GetCategories with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// Page Configures pagination.
// This parameter has the `from` and `size` properties.
Page *types.Page `json:"page,omitempty"`
}
Request holds the request body struct for the package getcategories
Source Files