Documentation
¶
Overview ¶
Provides quick access to the document count of the entire cluster, or individual indices.
Index ¶
- Variables
- type Count
- func (r Count) Do(providedCtx context.Context) (Response, error)
- func (r *Count) Header(key, value string) *Count
- func (r *Count) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Count) Index(index string) *Count
- func (r Count) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Count) Perform(providedCtx context.Context) (*http.Response, error)
- type NewCount
- 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 Count ¶
type Count struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Count
Provides quick access to the document count of the entire cluster, or individual indices.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html
func (Count) Do ¶
Do runs the request through the transport, handle the response and returns a count.Response
func (*Count) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Count) Index ¶
Index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
type NewCount ¶
type NewCount func() *Count
NewCount type alias for index.
func NewCountFunc ¶
func NewCountFunc(tp elastictransport.Interface) NewCount
NewCountFunc returns a new instance of Count 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 []types.CountRecord
Source Files