getdataframeanalytics

Documentation

Overview

Get data frame analytics job configuration info. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.

Index

• Variables
• type GetDataFrameAnalytics
  • func New(tp elastictransport.Interface) *GetDataFrameAnalytics
  • func (r *GetDataFrameAnalytics) AllowNoMatch(allownomatch bool) *GetDataFrameAnalytics
  • func (r GetDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetDataFrameAnalytics) ErrorTrace(errortrace bool) *GetDataFrameAnalytics
  • func (r *GetDataFrameAnalytics) ExcludeGenerated(excludegenerated bool) *GetDataFrameAnalytics
  • func (r *GetDataFrameAnalytics) FilterPath(filterpaths ...string) *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) Human(human bool) *GetDataFrameAnalytics
  • 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) Pretty(pretty bool) *GetDataFrameAnalytics
  • func (r *GetDataFrameAnalytics) Size(size int) *GetDataFrameAnalytics
• type NewGetDataFrameAnalytics
  • func NewGetDataFrameAnalyticsFunc(tp elastictransport.Interface) NewGetDataFrameAnalytics
• type Response
  • func NewResponse() *Response

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.

Types

type GetDataFrameAnalytics

type GetDataFrameAnalytics struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *GetDataFrameAnalytics

Get data frame analytics job configuration info. You can get information for multiple data frame analytics jobs in a single API request by using a comma-separated list of data frame analytics jobs or a wildcard expression.

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) ErrorTrace

func (r *GetDataFrameAnalytics) ErrorTrace(errortrace bool) *GetDataFrameAnalytics

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

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) FilterPath

func (r *GetDataFrameAnalytics) FilterPath(filterpaths ...string) *GetDataFrameAnalytics

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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

func (r *GetDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*GetDataFrameAnalytics) Human

func (r *GetDataFrameAnalytics) Human(human bool) *GetDataFrameAnalytics

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

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

func (r GetDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*GetDataFrameAnalytics) Pretty

func (r *GetDataFrameAnalytics) Pretty(pretty bool) *GetDataFrameAnalytics

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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

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

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsResponse.ts#L23-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response