segments

package
v8.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2023 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Provides low-level information about segments in a Lucene index.

Index

Constants

This section is empty.

Variables

View Source
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 NewSegments

type NewSegments func() *Segments

NewSegments type alias for index.

func NewSegmentsFunc

func NewSegmentsFunc(tp elastictransport.Interface) NewSegments

NewSegmentsFunc returns a new instance of Segments with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Segments

type Segments struct {
	// contains filtered or unexported fields
}

func New

Provides low-level information about segments in a Lucene index.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.html

func (*Segments) AllowNoIndices

func (r *Segments) AllowNoIndices(b bool) *Segments

AllowNoIndices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) API name: allow_no_indices

func (Segments) Do

func (r Segments) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*Segments) ExpandWildcards

func (r *Segments) ExpandWildcards(value string) *Segments

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards

func (*Segments) Header

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

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

func (*Segments) HttpRequest

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

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

func (*Segments) IgnoreUnavailable

func (r *Segments) IgnoreUnavailable(b bool) *Segments

IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable

func (*Segments) Index

func (r *Segments) Index(v string) *Segments

Index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices API Name: index

func (Segments) IsSuccess

func (r Segments) IsSuccess(ctx 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 (*Segments) Verbose

func (r *Segments) Verbose(b bool) *Segments

Verbose Includes detailed memory usage by Lucene. API name: verbose

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL