Documentation
¶
Overview ¶
Performs the flush operation on one or more indices.
Index ¶
- Variables
- type Flush
- func (r *Flush) AllowNoIndices(allownoindices bool) *Flush
- func (r Flush) Do(providedCtx context.Context) (*Response, error)
- func (r *Flush) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Flush
- func (r *Flush) Force(force bool) *Flush
- func (r *Flush) Header(key, value string) *Flush
- func (r *Flush) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Flush) IgnoreUnavailable(ignoreunavailable bool) *Flush
- func (r *Flush) Index(index string) *Flush
- func (r Flush) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Flush) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Flush) WaitIfOngoing(waitifongoing bool) *Flush
- type NewFlush
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
Types ¶
type Flush ¶
type Flush struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Flush
Performs the flush operation on one or more indices.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html
func (*Flush) AllowNoIndices ¶
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 (Flush) Do ¶
Do runs the request through the transport, handle the response and returns a flush.Response
func (*Flush) ExpandWildcards ¶
func (r *Flush) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Flush
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 (*Flush) Force ¶
Force If `true`, the request forces a flush even if there are no changes to commit to the index. API name: force
func (*Flush) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Flush) IgnoreUnavailable ¶
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*Flush) Index ¶
Index Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
func (Flush) IsSuccess ¶
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 (Flush) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*Flush) WaitIfOngoing ¶
WaitIfOngoing If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. API name: wait_if_ongoing
type NewFlush ¶
type NewFlush func() *Flush
NewFlush type alias for index.
func NewFlushFunc ¶
func NewFlushFunc(tp elastictransport.Interface) NewFlush
NewFlushFunc returns a new instance of Flush 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 struct {
Shards_ types.ShardStatistics `json:"_shards"`
}
Response holds the response body struct for the package flush
Source Files