Documentation
¶
Overview ¶
Starts a data frame analytics job.
Index ¶
- Variables
- type NewStartDataFrameAnalytics
- type Response
- type StartDataFrameAnalytics
- func (r StartDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
- func (r *StartDataFrameAnalytics) Header(key, value string) *StartDataFrameAnalytics
- func (r *StartDataFrameAnalytics) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r StartDataFrameAnalytics) IsSuccess(providedCtx context.Context) (bool, error)
- func (r StartDataFrameAnalytics) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *StartDataFrameAnalytics) Timeout(duration string) *StartDataFrameAnalytics
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 NewStartDataFrameAnalytics ¶
type NewStartDataFrameAnalytics func(id string) *StartDataFrameAnalytics
NewStartDataFrameAnalytics type alias for index.
func NewStartDataFrameAnalyticsFunc ¶
func NewStartDataFrameAnalyticsFunc(tp elastictransport.Interface) NewStartDataFrameAnalytics
NewStartDataFrameAnalyticsFunc returns a new instance of StartDataFrameAnalytics 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 {
Acknowledged bool `json:"acknowledged"`
// Node The ID of the node that the job was started on. If the job is allowed to open
// lazily and has not yet been assigned to a node, this value is an empty
// string.
// The node ID of the node the job has been assigned to, or
// an empty string if it hasn't been assigned to a node. In
// serverless if the job has been assigned to run then the
// node ID will be "serverless".
Node string `json:"node"`
}
Response holds the response body struct for the package startdataframeanalytics
type StartDataFrameAnalytics ¶
type StartDataFrameAnalytics struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *StartDataFrameAnalytics
Starts a data frame analytics job.
https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html
func (StartDataFrameAnalytics) Do ¶
func (r StartDataFrameAnalytics) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a startdataframeanalytics.Response
func (*StartDataFrameAnalytics) Header ¶
func (r *StartDataFrameAnalytics) Header(key, value string) *StartDataFrameAnalytics
Header set a key, value pair in the StartDataFrameAnalytics headers map.
func (*StartDataFrameAnalytics) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (StartDataFrameAnalytics) IsSuccess ¶
func (r StartDataFrameAnalytics) 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 (StartDataFrameAnalytics) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*StartDataFrameAnalytics) Timeout ¶
func (r *StartDataFrameAnalytics) Timeout(duration string) *StartDataFrameAnalytics
Timeout Controls the amount of time to wait until the data frame analytics job starts. API name: timeout
Source Files