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(b bool) *Refresh
  • func (r Refresh) Do(ctx context.Context) (*Response, error)
  • func (r *Refresh) ExpandWildcards(v string) *Refresh
  • func (r *Refresh) Header(key, value string) *Refresh
  • func (r *Refresh) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Refresh) IgnoreUnavailable(b bool) *Refresh
  • func (r *Refresh) Index(v string) *Refresh
  • func (r Refresh) IsSuccess(ctx context.Context) (bool, error)
  • func (r Refresh) Perform(ctx 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/master/indices-refresh.html

func (*Refresh) AllowNoIndices

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

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

func (r Refresh) Do(ctx 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(v string) *Refresh

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. 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(b bool) *Refresh

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

func (*Refresh) Index

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

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

func (Refresh) IsSuccess

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

func (r Refresh) Perform(ctx 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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response