forcemerge

Documentation

Overview

Performs the force merge operation on one or more indices.

Index

• Variables
• type Forcemerge
  • func New(tp elastictransport.Interface) *Forcemerge
  • func (r *Forcemerge) AllowNoIndices(allownoindices bool) *Forcemerge
  • func (r Forcemerge) Do(providedCtx context.Context) (*Response, error)
  • func (r *Forcemerge) ErrorTrace(errortrace bool) *Forcemerge
  • func (r *Forcemerge) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Forcemerge
  • func (r *Forcemerge) FilterPath(filterpaths ...string) *Forcemerge
  • func (r *Forcemerge) Flush(flush bool) *Forcemerge
  • func (r *Forcemerge) Header(key, value string) *Forcemerge
  • func (r *Forcemerge) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Forcemerge) Human(human bool) *Forcemerge
  • func (r *Forcemerge) IgnoreUnavailable(ignoreunavailable bool) *Forcemerge
  • func (r *Forcemerge) Index(index string) *Forcemerge
  • func (r Forcemerge) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Forcemerge) MaxNumSegments(maxnumsegments string) *Forcemerge
  • func (r *Forcemerge) OnlyExpungeDeletes(onlyexpungedeletes bool) *Forcemerge
  • func (r Forcemerge) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Forcemerge) Pretty(pretty bool) *Forcemerge
  • func (r *Forcemerge) WaitForCompletion(waitforcompletion bool) *Forcemerge
• type NewForcemerge
  • func NewForcemergeFunc(tp elastictransport.Interface) NewForcemerge
• type Response
  • func NewResponse() *Response

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 Forcemerge

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

func New

func New(tp elastictransport.Interface) *Forcemerge

Performs the force merge operation on one or more indices.

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

func (*Forcemerge) AllowNoIndices

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

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 (Forcemerge) Do

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

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

func (*Forcemerge) ErrorTrace

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

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

func (*Forcemerge) ExpandWildcards

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

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

func (*Forcemerge) FilterPath

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

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

func (*Forcemerge) Flush

func (r *Forcemerge) Flush(flush bool) *Forcemerge

Flush Specify whether the index should be flushed after performing the operation (default: true) API name: flush

func (*Forcemerge) Header

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

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

func (*Forcemerge) HttpRequest

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

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

func (*Forcemerge) Human

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

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 (*Forcemerge) IgnoreUnavailable

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

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

func (*Forcemerge) Index

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

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

func (Forcemerge) IsSuccess

func (r Forcemerge) 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 (*Forcemerge) MaxNumSegments

func (r *Forcemerge) MaxNumSegments(maxnumsegments string) *Forcemerge

MaxNumSegments The number of segments the index should be merged into (default: dynamic) API name: max_num_segments

func (*Forcemerge) OnlyExpungeDeletes

func (r *Forcemerge) OnlyExpungeDeletes(onlyexpungedeletes bool) *Forcemerge

OnlyExpungeDeletes Specify whether the operation should only expunge deleted documents API name: only_expunge_deletes

func (Forcemerge) Perform

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

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

func (*Forcemerge) Pretty

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

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

func (*Forcemerge) WaitForCompletion

func (r *Forcemerge) WaitForCompletion(waitforcompletion bool) *Forcemerge

WaitForCompletion Should the request wait until the force merge is completed. API name: wait_for_completion

type NewForcemerge

type NewForcemerge func() *Forcemerge

NewForcemerge type alias for index.

func NewForcemergeFunc

func NewForcemergeFunc(tp elastictransport.Interface) NewForcemerge

NewForcemergeFunc returns a new instance of Forcemerge 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 {
	Shards_ *types.ShardStatistics `json:"_shards,omitempty"`
	// Task task contains a task id returned when wait_for_completion=false,
	// you can use the task_id to get the status of the task at _tasks/<task_id>
	Task *string `json:"task,omitempty"`
}

Response holds the response body struct for the package forcemerge

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/indices/forcemerge/IndicesForceMergeResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response