segments

Documentation

Overview

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

Index

• Variables
• type NewSegments
  • func NewSegmentsFunc(tp elastictransport.Interface) NewSegments
• type Response
  • func NewResponse() *Response
• type Segments
  • func New(tp elastictransport.Interface) *Segments
  • func (r *Segments) AllowNoIndices(allownoindices bool) *Segments
  • func (r Segments) Do(providedCtx context.Context) (*Response, error)
  • func (r *Segments) ErrorTrace(errortrace bool) *Segments
  • func (r *Segments) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Segments
  • func (r *Segments) FilterPath(filterpaths ...string) *Segments
  • func (r *Segments) Header(key, value string) *Segments
  • func (r *Segments) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Segments) Human(human bool) *Segments
  • func (r *Segments) IgnoreUnavailable(ignoreunavailable bool) *Segments
  • func (r *Segments) Index(index string) *Segments
  • func (r Segments) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Segments) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Segments) Pretty(pretty bool) *Segments
  • func (r *Segments) Verbose(verbose bool) *Segments

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 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 Response

type Response struct {
	Indices map[string]types.IndexSegment `json:"indices"`
	Shards_ types.ShardStatistics         `json:"_shards"`
}

Response holds the response body struct for the package segments

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/indices/segments/IndicesSegmentsResponse.ts#L24-L29

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Segments

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

func New

func New(tp elastictransport.Interface) *Segments

Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the stream’s backing indices.

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

func (*Segments) AllowNoIndices

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

AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. API name: allow_no_indices

func (Segments) Do

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

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

func (*Segments) ErrorTrace

func (r *Segments) ErrorTrace(errortrace bool) *Segments

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*Segments) ExpandWildcards

func (r *Segments) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Segments

ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards

func (*Segments) FilterPath

func (r *Segments) FilterPath(filterpaths ...string) *Segments

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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) Human

func (r *Segments) Human(human bool) *Segments

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*Segments) IgnoreUnavailable

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

IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable

func (*Segments) Index

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

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 (Segments) IsSuccess

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

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

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

func (*Segments) Pretty

func (r *Segments) Pretty(pretty bool) *Segments

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*Segments) Verbose

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

Verbose If `true`, the request returns a verbose response. API name: verbose