datastreamsstats

Documentation

Overview

Get data stream stats. Retrieves statistics for one or more data streams.

Index

• Variables
• type DataStreamsStats
  • func New(tp elastictransport.Interface) *DataStreamsStats
  • func (r DataStreamsStats) Do(providedCtx context.Context) (*Response, error)
  • func (r *DataStreamsStats) ErrorTrace(errortrace bool) *DataStreamsStats
  • func (r *DataStreamsStats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DataStreamsStats
  • func (r *DataStreamsStats) FilterPath(filterpaths ...string) *DataStreamsStats
  • func (r *DataStreamsStats) Header(key, value string) *DataStreamsStats
  • func (r *DataStreamsStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DataStreamsStats) Human(human bool) *DataStreamsStats
  • func (r DataStreamsStats) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *DataStreamsStats) Name(name string) *DataStreamsStats
  • func (r DataStreamsStats) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DataStreamsStats) Pretty(pretty bool) *DataStreamsStats
• type NewDataStreamsStats
  • func NewDataStreamsStatsFunc(tp elastictransport.Interface) NewDataStreamsStats
• 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 DataStreamsStats

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

func New

func New(tp elastictransport.Interface) *DataStreamsStats

Get data stream stats. Retrieves statistics for one or more data streams.

https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html

func (DataStreamsStats) Do

func (r DataStreamsStats) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a datastreamsstats.Response

func (*DataStreamsStats) ErrorTrace

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

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

func (*DataStreamsStats) ExpandWildcards

func (r *DataStreamsStats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DataStreamsStats

ExpandWildcards Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. API name: expand_wildcards

func (*DataStreamsStats) FilterPath

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

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

func (*DataStreamsStats) Header

func (r *DataStreamsStats) Header(key, value string) *DataStreamsStats

Header set a key, value pair in the DataStreamsStats headers map.

func (*DataStreamsStats) HttpRequest

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

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

func (*DataStreamsStats) Human

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

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 (DataStreamsStats) IsSuccess

func (r DataStreamsStats) 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 (*DataStreamsStats) Name

func (r *DataStreamsStats) Name(name string) *DataStreamsStats

Name Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a cluster, omit this parameter or use `*`. API Name: name

func (DataStreamsStats) Perform

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

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

func (*DataStreamsStats) Pretty

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

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

type NewDataStreamsStats

type NewDataStreamsStats func() *DataStreamsStats

NewDataStreamsStats type alias for index.

func NewDataStreamsStatsFunc

func NewDataStreamsStatsFunc(tp elastictransport.Interface) NewDataStreamsStats

NewDataStreamsStatsFunc returns a new instance of DataStreamsStats 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 {

	// BackingIndices Total number of backing indices for the selected data streams.
	BackingIndices int `json:"backing_indices"`
	// DataStreamCount Total number of selected data streams.
	DataStreamCount int `json:"data_stream_count"`
	// DataStreams Contains statistics for the selected data streams.
	DataStreams []types.DataStreamsStatsItem `json:"data_streams"`
	// Shards_ Contains information about shards that attempted to execute the request.
	Shards_ types.ShardStatistics `json:"_shards"`
	// TotalStoreSizeBytes Total size, in bytes, of all shards for the selected data streams.
	TotalStoreSizeBytes int64 `json:"total_store_size_bytes"`
	// TotalStoreSizes Total size of all shards for the selected data streams.
	// This property is included only if the `human` query parameter is `true`
	TotalStoreSizes types.ByteSize `json:"total_store_sizes,omitempty"`
}

Response holds the response body struct for the package datastreamsstats

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/data_streams_stats/IndicesDataStreamsStatsResponse.ts#L25-L43

func NewResponse

func NewResponse() *Response

NewResponse returns a Response