Documentation
¶
Overview ¶
Returns information about indices: number of primaries and replicas, document counts, disk size, ...
Index ¶
- Variables
- type Indices
- func (r *Indices) Bytes(bytes bytes.Bytes) *Indices
- func (r Indices) Do(providedCtx context.Context) (Response, error)
- func (r *Indices) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Indices
- func (r *Indices) Header(key, value string) *Indices
- func (r *Indices) Health(health healthstatus.HealthStatus) *Indices
- func (r *Indices) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Indices) IncludeUnloadedSegments(includeunloadedsegments bool) *Indices
- func (r *Indices) Index(index string) *Indices
- func (r Indices) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Indices) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Indices) Pri(pri bool) *Indices
- func (r *Indices) Time(time timeunit.TimeUnit) *Indices
- type NewIndices
- 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 Indices ¶
type Indices struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Indices
Returns information about indices: number of primaries and replicas, document counts, disk size, ...
https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html
func (Indices) Do ¶
Do runs the request through the transport, handle the response and returns a indices.Response
func (*Indices) ExpandWildcards ¶
func (r *Indices) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Indices
ExpandWildcards The type of index that wildcard patterns can match. API name: expand_wildcards
func (*Indices) Health ¶
func (r *Indices) Health(health healthstatus.HealthStatus) *Indices
Health The health status used to limit returned indices. By default, the response includes indices of any health status. API name: health
func (*Indices) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Indices) IncludeUnloadedSegments ¶
IncludeUnloadedSegments If true, the response includes information from segments that are not loaded into memory. API name: include_unloaded_segments
func (*Indices) 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
func (Indices) IsSuccess ¶
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 (Indices) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
type NewIndices ¶
type NewIndices func() *Indices
NewIndices type alias for index.
func NewIndicesFunc ¶
func NewIndicesFunc(tp elastictransport.Interface) NewIndices
NewIndicesFunc returns a new instance of Indices 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.IndicesRecord
Source Files