segments

Documentation

Overview

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

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) Bytes(bytes bytes.Bytes) *Segments
  • func (r Segments) Do(providedCtx context.Context) (Response, error)
  • func (r *Segments) Header(key, value string) *Segments
  • func (r *Segments) HttpRequest(ctx context.Context) (*http.Request, error)
  • 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)

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 []types.SegmentsRecord

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

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

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

func (*Segments) Bytes

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

Bytes The unit used to display byte values. API name: bytes

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) 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(index string) *Segments

Index A 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.