The highest tagged major version is
Documentation
¶
Overview ¶
Get data stream lifecycle stats. Get statistics about the data streams that are managed by a data stream lifecycle.
Index ¶
- Variables
- type GetDataLifecycleStats
- func (r GetDataLifecycleStats) Do(providedCtx context.Context) (*Response, error)
- func (r *GetDataLifecycleStats) ErrorTrace(errortrace bool) *GetDataLifecycleStats
- func (r *GetDataLifecycleStats) FilterPath(filterpaths ...string) *GetDataLifecycleStats
- func (r *GetDataLifecycleStats) Header(key, value string) *GetDataLifecycleStats
- func (r *GetDataLifecycleStats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetDataLifecycleStats) Human(human bool) *GetDataLifecycleStats
- func (r GetDataLifecycleStats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r GetDataLifecycleStats) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *GetDataLifecycleStats) Pretty(pretty bool) *GetDataLifecycleStats
- type NewGetDataLifecycleStats
- 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 GetDataLifecycleStats ¶
type GetDataLifecycleStats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetDataLifecycleStats
Get data stream lifecycle stats. Get statistics about the data streams that are managed by a data stream lifecycle.
func (GetDataLifecycleStats) Do ¶
func (r GetDataLifecycleStats) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a getdatalifecyclestats.Response
func (*GetDataLifecycleStats) ErrorTrace ¶
func (r *GetDataLifecycleStats) ErrorTrace(errortrace bool) *GetDataLifecycleStats
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*GetDataLifecycleStats) FilterPath ¶
func (r *GetDataLifecycleStats) FilterPath(filterpaths ...string) *GetDataLifecycleStats
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*GetDataLifecycleStats) Header ¶
func (r *GetDataLifecycleStats) Header(key, value string) *GetDataLifecycleStats
Header set a key, value pair in the GetDataLifecycleStats headers map.
func (*GetDataLifecycleStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetDataLifecycleStats) Human ¶
func (r *GetDataLifecycleStats) Human(human bool) *GetDataLifecycleStats
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 (GetDataLifecycleStats) IsSuccess ¶
func (r GetDataLifecycleStats) 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 (GetDataLifecycleStats) Perform ¶
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*GetDataLifecycleStats) Pretty ¶
func (r *GetDataLifecycleStats) Pretty(pretty bool) *GetDataLifecycleStats
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type NewGetDataLifecycleStats ¶
type NewGetDataLifecycleStats func() *GetDataLifecycleStats
NewGetDataLifecycleStats type alias for index.
func NewGetDataLifecycleStatsFunc ¶
func NewGetDataLifecycleStatsFunc(tp elastictransport.Interface) NewGetDataLifecycleStats
NewGetDataLifecycleStatsFunc returns a new instance of GetDataLifecycleStats 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 {
// DataStreamCount The count of data streams currently being managed by the data stream
// lifecycle.
DataStreamCount int `json:"data_stream_count"`
// DataStreams Information about the data streams that are managed by the data stream
// lifecycle.
DataStreams []types.DataStreamStats `json:"data_streams"`
// LastRunDurationInMillis The duration of the last data stream lifecycle execution.
LastRunDurationInMillis *int64 `json:"last_run_duration_in_millis,omitempty"`
// TimeBetweenStartsInMillis The time that passed between the start of the last two data stream lifecycle
// executions.
// This value should amount approximately to
// `data_streams.lifecycle.poll_interval`.
TimeBetweenStartsInMillis *int64 `json:"time_between_starts_in_millis,omitempty"`
}
Response holds the response body struct for the package getdatalifecyclestats
Source Files