Documentation
¶
Overview ¶
Retrieve node-level cache statistics about searchable snapshots.
Index ¶
- Variables
- type CacheStats
- func (r CacheStats) Do(providedCtx context.Context) (*Response, error)
- func (r *CacheStats) Header(key, value string) *CacheStats
- func (r *CacheStats) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r CacheStats) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *CacheStats) MasterTimeout(duration string) *CacheStats
- func (r *CacheStats) NodeId(nodeid string) *CacheStats
- func (r CacheStats) Perform(providedCtx context.Context) (*http.Response, error)
- type NewCacheStats
- 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 CacheStats ¶
type CacheStats struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *CacheStats
Retrieve node-level cache statistics about searchable snapshots.
https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html
func (CacheStats) Do ¶
func (r CacheStats) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a cachestats.Response
func (*CacheStats) Header ¶
func (r *CacheStats) Header(key, value string) *CacheStats
Header set a key, value pair in the CacheStats headers map.
func (*CacheStats) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (CacheStats) IsSuccess ¶
func (r CacheStats) 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 (*CacheStats) MasterTimeout ¶
func (r *CacheStats) MasterTimeout(duration string) *CacheStats
API name: master_timeout
func (*CacheStats) NodeId ¶
func (r *CacheStats) NodeId(nodeid string) *CacheStats
NodeId A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes API Name: nodeid
type NewCacheStats ¶
type NewCacheStats func() *CacheStats
NewCacheStats type alias for index.
func NewCacheStatsFunc ¶
func NewCacheStatsFunc(tp elastictransport.Interface) NewCacheStats
NewCacheStatsFunc returns a new instance of CacheStats with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files