Documentation
¶
Overview ¶
Clear the cache of searchable snapshots.
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) Header(key, value string) *ClearCache
- func (r *ClearCache) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ClearCache) Human(human bool) *ClearCache
- 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) Pretty(pretty 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
Clear the cache of searchable snapshots.
https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html
func (*ClearCache) AllowNoIndices ¶
func (r *ClearCache) AllowNoIndices(allownoindices bool) *ClearCache
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 (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 Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards
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 Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable
func (*ClearCache) Index ¶
func (r *ClearCache) Index(index string) *ClearCache
Index A comma-separated list of index names 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.
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 = json.RawMessage
func NewResponse ¶ added in v8.7.1
func NewResponse() *Response
Source Files