Documentation
¶
Overview ¶
Clears all or specific caches for one or more indices.
Index ¶
- Variables
- type ClearCache
- func (r *ClearCache) AllowNoIndices(allownoindices bool) *ClearCache
- func (r ClearCache) Do(providedCtx context.Context) (*Response, error)
- func (r *ClearCache) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ClearCache
- func (r *ClearCache) Fielddata(fielddata bool) *ClearCache
- func (r *ClearCache) Fields(fields ...string) *ClearCache
- func (r *ClearCache) Header(key, value string) *ClearCache
- func (r *ClearCache) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ClearCache) IgnoreUnavailable(ignoreunavailable bool) *ClearCache
- func (r *ClearCache) Index(index string) *ClearCache
- func (r ClearCache) IsSuccess(providedCtx context.Context) (bool, error)
- func (r ClearCache) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ClearCache) Query(query bool) *ClearCache
- func (r *ClearCache) Request(request bool) *ClearCache
- type NewClearCache
- 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 ClearCache ¶
type ClearCache struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ClearCache
Clears all or specific caches for one or more indices.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html
func (*ClearCache) AllowNoIndices ¶
func (r *ClearCache) AllowNoIndices(allownoindices bool) *ClearCache
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 (ClearCache) Do ¶
func (r ClearCache) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a clearcache.Response
func (*ClearCache) ExpandWildcards ¶
func (r *ClearCache) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ClearCache
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 (*ClearCache) Fielddata ¶
func (r *ClearCache) Fielddata(fielddata bool) *ClearCache
Fielddata If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only. API name: fielddata
func (*ClearCache) Fields ¶
func (r *ClearCache) Fields(fields ...string) *ClearCache
Fields Comma-separated list of field names used to limit the `fielddata` parameter. API name: fields
func (*ClearCache) Header ¶
func (r *ClearCache) Header(key, value string) *ClearCache
Header set a key, value pair in the ClearCache headers map.
func (*ClearCache) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ClearCache) IgnoreUnavailable ¶
func (r *ClearCache) IgnoreUnavailable(ignoreunavailable bool) *ClearCache
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*ClearCache) Index ¶
func (r *ClearCache) Index(index string) *ClearCache
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 (ClearCache) IsSuccess ¶
func (r ClearCache) 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 (ClearCache) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ClearCache) Query ¶
func (r *ClearCache) Query(query bool) *ClearCache
Query If `true`, clears the query cache. API name: query
func (*ClearCache) Request ¶
func (r *ClearCache) Request(request bool) *ClearCache
Request If `true`, clears the request cache. API name: request
type NewClearCache ¶
type NewClearCache func() *ClearCache
NewClearCache type alias for index.
func NewClearCacheFunc ¶
func NewClearCacheFunc(tp elastictransport.Interface) NewClearCache
NewClearCacheFunc returns a new instance of ClearCache 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 clearcache
Source Files