Documentation
¶
Overview ¶
Retrieves configuration information for data frame analytics jobs.
Index ¶
- Variables
- type GetDataFrameAnalytics
- func (r *GetDataFrameAnalytics) AllowNoMatch(allownomatch bool) *GetDataFrameAnalytics
- func (r GetDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
- func (r *GetDataFrameAnalytics) ExcludeGenerated(excludegenerated bool) *GetDataFrameAnalytics
- func (r *GetDataFrameAnalytics) From(from int) *GetDataFrameAnalytics
- func (r *GetDataFrameAnalytics) Header(key, value string) *GetDataFrameAnalytics
- func (r *GetDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetDataFrameAnalytics) Id(id string) *GetDataFrameAnalytics
- func (r GetDataFrameAnalytics) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetDataFrameAnalytics) Size(size int) *GetDataFrameAnalytics
- type NewGetDataFrameAnalytics
- 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 GetDataFrameAnalytics ¶
type GetDataFrameAnalytics struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetDataFrameAnalytics
Retrieves configuration information for data frame analytics jobs.
https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html
func (*GetDataFrameAnalytics) AllowNoMatch ¶
func (r *GetDataFrameAnalytics) AllowNoMatch(allownomatch bool) *GetDataFrameAnalytics
AllowNoMatch Specifies what to do when the request:
1. Contains wildcard expressions and there are no data frame analytics jobs 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 returns an empty data_frame_analytics 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 (GetDataFrameAnalytics) Do ¶
func (r GetDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getdataframeanalytics.Response
func (*GetDataFrameAnalytics) ExcludeGenerated ¶
func (r *GetDataFrameAnalytics) ExcludeGenerated(excludegenerated bool) *GetDataFrameAnalytics
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 (*GetDataFrameAnalytics) From ¶
func (r *GetDataFrameAnalytics) From(from int) *GetDataFrameAnalytics
From Skips the specified number of data frame analytics jobs. API name: from
func (*GetDataFrameAnalytics) Header ¶
func (r *GetDataFrameAnalytics) Header(key, value string) *GetDataFrameAnalytics
Header set a key, value pair in the GetDataFrameAnalytics headers map.
func (*GetDataFrameAnalytics) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetDataFrameAnalytics) Id ¶
func (r *GetDataFrameAnalytics) Id(id string) *GetDataFrameAnalytics
Id Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs. API Name: id
func (GetDataFrameAnalytics) IsSuccess ¶
func (r GetDataFrameAnalytics) 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 (GetDataFrameAnalytics) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetDataFrameAnalytics) Size ¶
func (r *GetDataFrameAnalytics) Size(size int) *GetDataFrameAnalytics
Size Specifies the maximum number of data frame analytics jobs to obtain. API name: size
type NewGetDataFrameAnalytics ¶
type NewGetDataFrameAnalytics func() *GetDataFrameAnalytics
NewGetDataFrameAnalytics type alias for index.
func NewGetDataFrameAnalyticsFunc ¶
func NewGetDataFrameAnalyticsFunc(tp elastictransport.Interface) NewGetDataFrameAnalytics
NewGetDataFrameAnalyticsFunc returns a new instance of GetDataFrameAnalytics 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 int `json:"count"`
// DataFrameAnalytics An array of data frame analytics job resources, which are sorted by the id
// value in ascending order.
DataFrameAnalytics []types.DataframeAnalyticsSummary `json:"data_frame_analytics"`
}
Response holds the response body struct for the package getdataframeanalytics
Source Files