Documentation
¶
Overview ¶
Provides statistics on operations happening in a data stream.
Index ¶
- Variables
- type DataStreamsStats
- func (r DataStreamsStats) Do(providedCtx context.Context) (*Response, error)
- func (r *DataStreamsStats) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *DataStreamsStats
- func (r *DataStreamsStats) Header(key, value string) *DataStreamsStats
- func (r *DataStreamsStats) HttpRequest(ctx context.Context) (*http.Request, error)
- 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)
- type NewDataStreamsStats
- 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 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/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) 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) Header ¶
func (r *DataStreamsStats) Header(key, value string) *DataStreamsStats
Header set a key, value pair in the DataStreamsStats headers map.
func (*DataStreamsStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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
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 ¶ added in v8.7.0
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
Source Files