Documentation
¶
Overview ¶
Forces any buffered data to be processed by the job.
Index ¶
- Variables
- type FlushJob
- func (r *FlushJob) AdvanceTime(datetime types.DateTime) *FlushJob
- func (r *FlushJob) CalcInterim(calcinterim bool) *FlushJob
- func (r FlushJob) Do(providedCtx context.Context) (*Response, error)
- func (r *FlushJob) End(datetime types.DateTime) *FlushJob
- func (r *FlushJob) Header(key, value string) *FlushJob
- func (r *FlushJob) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r FlushJob) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *FlushJob) Raw(raw io.Reader) *FlushJob
- func (r *FlushJob) Request(req *Request) *FlushJob
- func (r *FlushJob) SkipTime(datetime types.DateTime) *FlushJob
- func (r *FlushJob) Start(datetime types.DateTime) *FlushJob
- type NewFlushJob
- 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 FlushJob ¶
type FlushJob struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *FlushJob
Forces any buffered data to be processed by the job.
https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html
func (*FlushJob) AdvanceTime ¶
AdvanceTime Refer to the description for the `advance_time` query parameter. API name: advance_time
func (*FlushJob) CalcInterim ¶
CalcInterim Refer to the description for the `calc_interim` query parameter. API name: calc_interim
func (FlushJob) Do ¶
Do runs the request through the transport, handle the response and returns a flushjob.Response
func (*FlushJob) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (FlushJob) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*FlushJob) Raw ¶
Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.
type NewFlushJob ¶
NewFlushJob type alias for index.
func NewFlushJobFunc ¶
func NewFlushJobFunc(tp elastictransport.Interface) NewFlushJob
NewFlushJobFunc returns a new instance of FlushJob with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type Request ¶
type Request struct {
// AdvanceTime Refer to the description for the `advance_time` query parameter.
AdvanceTime types.DateTime `json:"advance_time,omitempty"`
// CalcInterim Refer to the description for the `calc_interim` query parameter.
CalcInterim *bool `json:"calc_interim,omitempty"`
// End Refer to the description for the `end` query parameter.
End types.DateTime `json:"end,omitempty"`
// SkipTime Refer to the description for the `skip_time` query parameter.
SkipTime types.DateTime `json:"skip_time,omitempty"`
// Start Refer to the description for the `start` query parameter.
Start types.DateTime `json:"start,omitempty"`
}
Request holds the request body struct for the package flushjob
func (*Request) FromJSON ¶ added in v8.5.0
FromJSON allows to load an arbitrary json into the request structure
func (*Request) UnmarshalJSON ¶ added in v8.12.1
type Response ¶ added in v8.7.0
type Response struct {
Flushed bool `json:"flushed"`
// LastFinalizedBucketEnd Provides the timestamp (in milliseconds since the epoch) of the end of
// the last bucket that was processed.
LastFinalizedBucketEnd *int `json:"last_finalized_bucket_end,omitempty"`
}
Response holds the response body struct for the package flushjob
Source Files