refresh

Documentation

Overview

Performs the refresh operation in one or more indices.

Index

• Variables
• type NewRefresh
  • func NewRefreshFunc(tp elastictransport.Interface) NewRefresh
• type Refresh
  • func New(tp elastictransport.Interface) *Refresh
  • func (r *Refresh) AllowNoIndices(allownoindices bool) *Refresh
  • func (r Refresh) Do(providedCtx context.Context) (*Response, error)
  • func (r *Refresh) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Refresh
  • func (r *Refresh) Header(key, value string) *Refresh
  • func (r *Refresh) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Refresh) IgnoreUnavailable(ignoreunavailable bool) *Refresh
  • func (r *Refresh) Index(index string) *Refresh
  • func (r Refresh) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Refresh) Perform(providedCtx context.Context) (*http.Response, error)
• 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 NewRefresh

type NewRefresh func() *Refresh

NewRefresh type alias for index.

func NewRefreshFunc

func NewRefreshFunc(tp elastictransport.Interface) NewRefresh

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

type Refresh

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

func New

func New(tp elastictransport.Interface) *Refresh

Performs the refresh operation in one or more indices.

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

func (*Refresh) AllowNoIndices

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

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

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

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

func (*Refresh) ExpandWildcards

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

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 (*Refresh) Header

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

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

func (*Refresh) HttpRequest

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

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

func (*Refresh) IgnoreUnavailable

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

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

func (*Refresh) Index

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

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

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

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

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

type Response

type Response struct {
	Shards_ types.ShardStatistics `json:"_shards"`
}

Response holds the response body struct for the package refresh

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/refresh/IndicesRefreshResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response