Documentation
¶
Overview ¶
Previews that will be analyzed given a data frame analytics config.
Index ¶
- Variables
- type NewPreviewDataFrameAnalytics
- type PreviewDataFrameAnalytics
- func (r *PreviewDataFrameAnalytics) Config(config *types.DataframePreviewConfig) *PreviewDataFrameAnalytics
- func (r PreviewDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
- func (r *PreviewDataFrameAnalytics) Header(key, value string) *PreviewDataFrameAnalytics
- func (r *PreviewDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *PreviewDataFrameAnalytics) Id(id string) *PreviewDataFrameAnalytics
- func (r PreviewDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PreviewDataFrameAnalytics) Raw(raw io.Reader) *PreviewDataFrameAnalytics
- func (r *PreviewDataFrameAnalytics) Request(req *Request) *PreviewDataFrameAnalytics
- 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 NewPreviewDataFrameAnalytics ¶
type NewPreviewDataFrameAnalytics func() *PreviewDataFrameAnalytics
NewPreviewDataFrameAnalytics type alias for index.
func NewPreviewDataFrameAnalyticsFunc ¶
func NewPreviewDataFrameAnalyticsFunc(tp elastictransport.Interface) NewPreviewDataFrameAnalytics
NewPreviewDataFrameAnalyticsFunc returns a new instance of PreviewDataFrameAnalytics with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type PreviewDataFrameAnalytics ¶
type PreviewDataFrameAnalytics struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *PreviewDataFrameAnalytics
Previews that will be analyzed given a data frame analytics config.
http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html
func (*PreviewDataFrameAnalytics) Config ¶ added in v8.9.0
func (r *PreviewDataFrameAnalytics) Config(config *types.DataframePreviewConfig) *PreviewDataFrameAnalytics
Config A data frame analytics config as described in create data frame analytics jobs. Note that `id` and `dest` don’t need to be provided in the context of this API. API name: config
func (PreviewDataFrameAnalytics) Do ¶
func (r PreviewDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a previewdataframeanalytics.Response
func (*PreviewDataFrameAnalytics) Header ¶
func (r *PreviewDataFrameAnalytics) Header(key, value string) *PreviewDataFrameAnalytics
Header set a key, value pair in the PreviewDataFrameAnalytics headers map.
func (*PreviewDataFrameAnalytics) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PreviewDataFrameAnalytics) Id ¶
func (r *PreviewDataFrameAnalytics) Id(id string) *PreviewDataFrameAnalytics
Id Identifier for the data frame analytics job. API Name: id
func (PreviewDataFrameAnalytics) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*PreviewDataFrameAnalytics) Raw ¶
func (r *PreviewDataFrameAnalytics) Raw(raw io.Reader) *PreviewDataFrameAnalytics
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
func (*PreviewDataFrameAnalytics) Request ¶
func (r *PreviewDataFrameAnalytics) Request(req *Request) *PreviewDataFrameAnalytics
Request allows to set the request property with the appropriate payload.
type Request ¶
type Request struct {
// Config A data frame analytics config as described in create data frame analytics
// jobs. Note that `id` and `dest` don’t need to be provided in the context of
// this API.
Config *types.DataframePreviewConfig `json:"config,omitempty"`
}
Request holds the request body struct for the package previewdataframeanalytics
type Response ¶ added in v8.7.0
type Response struct {
// FeatureValues An array of objects that contain feature name and value pairs. The features
// have been processed and indicate what will be sent to the model for training.
FeatureValues []map[string]string `json:"feature_values"`
}
Response holds the response body struct for the package previewdataframeanalytics
Source Files