count

Documentation

Overview

Provides quick access to the document count of the entire cluster, or individual indices.

Index

• Variables
• type Count
  • func New(tp elastictransport.Interface) *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
  • func NewCountFunc(tp elastictransport.Interface) NewCount
• 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 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

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

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

func (*Count) Header

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

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

func (*Count) HttpRequest

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

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

func (*Count) Index

func (r *Count) Index(index string) *Count

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

func (Count) IsSuccess

func (r Count) 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 (Count) Perform

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

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

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

type Response []types.CountRecord

func NewResponse

func NewResponse() Response

NewResponse returns a Response