datastreamsstats

Documentation

Overview

Provides statistics on operations happening in a data stream.

Index

• Variables
• type DataStreamsStats
  • func New(tp elastictransport.Interface) *DataStreamsStats
  • func (r DataStreamsStats) Do(ctx context.Context) (*http.Response, error)
  • func (r *DataStreamsStats) ExpandWildcards(value string) *DataStreamsStats
  • func (r *DataStreamsStats) Header(key, value string) *DataStreamsStats
  • func (r *DataStreamsStats) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DataStreamsStats) IsSuccess(ctx context.Context) (bool, error)
  • func (r *DataStreamsStats) Name(v string) *DataStreamsStats
• type NewDataStreamsStats
  • func NewDataStreamsStatsFunc(tp elastictransport.Interface) NewDataStreamsStats

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

Provides statistics on operations happening in a data stream.

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

func (DataStreamsStats) Do

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

Do runs the http.Request through the provided transport.

func (*DataStreamsStats) ExpandWildcards

func (r *DataStreamsStats) ExpandWildcards(value string) *DataStreamsStats

API name: expand_wildcards

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

func (r DataStreamsStats) IsSuccess(ctx 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(v string) *DataStreamsStats

Name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams API Name: name

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.