Documentation
¶
Overview ¶
Retrieves filters.
Index ¶
- Variables
- type GetFilters
- func (r GetFilters) Do(providedCtx context.Context) (*Response, error)
- func (r *GetFilters) FilterId(filterid string) *GetFilters
- func (r *GetFilters) From(from int) *GetFilters
- func (r *GetFilters) Header(key, value string) *GetFilters
- func (r *GetFilters) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetFilters) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetFilters) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetFilters) Size(size int) *GetFilters
- type NewGetFilters
- 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 GetFilters ¶
type GetFilters struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetFilters
Retrieves filters.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html
func (GetFilters) Do ¶
func (r GetFilters) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getfilters.Response
func (*GetFilters) FilterId ¶
func (r *GetFilters) FilterId(filterid string) *GetFilters
FilterId A string that uniquely identifies a filter. API Name: filterid
func (*GetFilters) From ¶
func (r *GetFilters) From(from int) *GetFilters
From Skips the specified number of filters. API name: from
func (*GetFilters) Header ¶
func (r *GetFilters) Header(key, value string) *GetFilters
Header set a key, value pair in the GetFilters headers map.
func (*GetFilters) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (GetFilters) IsSuccess ¶
func (r GetFilters) 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 (GetFilters) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetFilters) Size ¶
func (r *GetFilters) Size(size int) *GetFilters
Size Specifies the maximum number of filters to obtain. API name: size
type NewGetFilters ¶
type NewGetFilters func() *GetFilters
NewGetFilters type alias for index.
func NewGetFiltersFunc ¶
func NewGetFiltersFunc(tp elastictransport.Interface) NewGetFilters
NewGetFiltersFunc returns a new instance of GetFilters with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files