segments

package
v8.7.0 Latest Latest
Warning

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

Go to latest
Published: Mar 30, 2023 License: Apache-2.0 Imports: 13 Imported by: 4

Documentation

Overview

Provides low-level information about the segments in the shards of an 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 Response added in v8.7.0

type Response []types.SegmentsRecord

func NewResponse added in v8.7.0

func NewResponse() Response

NewResponse returns a Response

type Segments

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

func New

Provides low-level information about the segments in the shards of an index.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cat-segments.html

func (*Segments) Bytes

func (r *Segments) Bytes(enum bytes.Bytes) *Segments

Bytes The unit in which to display byte values API name: bytes

func (Segments) Do

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

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

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

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

Index A comma-separated list of index names to limit the returned information 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) Perform added in v8.7.0

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

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

Jump to

Keyboard shortcuts

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