Documentation
¶
Overview ¶
Retrieves configuration information for datafeeds.
Index ¶
- Variables
- type GetDatafeeds
- func (r *GetDatafeeds) AllowNoMatch(allownomatch bool) *GetDatafeeds
- func (r *GetDatafeeds) DatafeedId(datafeedid string) *GetDatafeeds
- func (r GetDatafeeds) Do(providedCtx context.Context) (*Response, error)
- func (r *GetDatafeeds) ExcludeGenerated(excludegenerated bool) *GetDatafeeds
- func (r *GetDatafeeds) Header(key, value string) *GetDatafeeds
- func (r *GetDatafeeds) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r GetDatafeeds) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetDatafeeds) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetDatafeeds
- 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 GetDatafeeds ¶
type GetDatafeeds struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetDatafeeds
Retrieves configuration information for datafeeds.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html
func (*GetDatafeeds) AllowNoMatch ¶
func (r *GetDatafeeds) AllowNoMatch(allownomatch bool) *GetDatafeeds
AllowNoMatch Specifies what to do when the request:
1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches.
The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. API name: allow_no_match
func (*GetDatafeeds) DatafeedId ¶
func (r *GetDatafeeds) DatafeedId(datafeedid string) *GetDatafeeds
DatafeedId Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds. API Name: datafeedid
func (GetDatafeeds) Do ¶
func (r GetDatafeeds) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getdatafeeds.Response
func (*GetDatafeeds) ExcludeGenerated ¶
func (r *GetDatafeeds) ExcludeGenerated(excludegenerated bool) *GetDatafeeds
ExcludeGenerated Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. API name: exclude_generated
func (*GetDatafeeds) Header ¶
func (r *GetDatafeeds) Header(key, value string) *GetDatafeeds
Header set a key, value pair in the GetDatafeeds headers map.
func (*GetDatafeeds) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
type NewGetDatafeeds ¶
type NewGetDatafeeds func() *GetDatafeeds
NewGetDatafeeds type alias for index.
func NewGetDatafeedsFunc ¶
func NewGetDatafeedsFunc(tp elastictransport.Interface) NewGetDatafeeds
NewGetDatafeedsFunc returns a new instance of GetDatafeeds with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Response ¶ added in v8.7.0
type Response struct {
Count int64 `json:"count"`
Datafeeds []types.MLDatafeed `json:"datafeeds"`
}
Response holds the response body struct for the package getdatafeeds
Source Files