Documentation
¶
Overview ¶
Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
Index ¶
- Variables
- type NewResolveIndex
- type ResolveIndex
- func (r *ResolveIndex) AllowNoIndices(allownoindices bool) *ResolveIndex
- func (r ResolveIndex) Do(providedCtx context.Context) (*Response, error)
- func (r *ResolveIndex) ErrorTrace(errortrace bool) *ResolveIndex
- func (r *ResolveIndex) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ResolveIndex
- func (r *ResolveIndex) FilterPath(filterpaths ...string) *ResolveIndex
- func (r *ResolveIndex) Header(key, value string) *ResolveIndex
- func (r *ResolveIndex) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ResolveIndex) Human(human bool) *ResolveIndex
- func (r *ResolveIndex) IgnoreUnavailable(ignoreunavailable bool) *ResolveIndex
- func (r ResolveIndex) IsSuccess(providedCtx context.Context) (bool, error)
- func (r ResolveIndex) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *ResolveIndex) Pretty(pretty bool) *ResolveIndex
- 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 NewResolveIndex ¶
type NewResolveIndex func(name string) *ResolveIndex
NewResolveIndex type alias for index.
func NewResolveIndexFunc ¶
func NewResolveIndexFunc(tp elastictransport.Interface) NewResolveIndex
NewResolveIndexFunc returns a new instance of ResolveIndex with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type ResolveIndex ¶
type ResolveIndex struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *ResolveIndex
Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-index-api.html
func (*ResolveIndex) AllowNoIndices ¶ added in v8.16.0
func (r *ResolveIndex) AllowNoIndices(allownoindices bool) *ResolveIndex
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. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. API name: allow_no_indices
func (ResolveIndex) Do ¶
func (r ResolveIndex) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a resolveindex.Response
func (*ResolveIndex) ErrorTrace ¶ added in v8.14.0
func (r *ResolveIndex) ErrorTrace(errortrace bool) *ResolveIndex
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*ResolveIndex) ExpandWildcards ¶
func (r *ResolveIndex) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ResolveIndex
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 (*ResolveIndex) FilterPath ¶ added in v8.14.0
func (r *ResolveIndex) FilterPath(filterpaths ...string) *ResolveIndex
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*ResolveIndex) Header ¶
func (r *ResolveIndex) Header(key, value string) *ResolveIndex
Header set a key, value pair in the ResolveIndex headers map.
func (*ResolveIndex) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*ResolveIndex) Human ¶ added in v8.14.0
func (r *ResolveIndex) Human(human bool) *ResolveIndex
Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human
func (*ResolveIndex) IgnoreUnavailable ¶ added in v8.16.0
func (r *ResolveIndex) IgnoreUnavailable(ignoreunavailable bool) *ResolveIndex
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (ResolveIndex) IsSuccess ¶
func (r ResolveIndex) 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 (ResolveIndex) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*ResolveIndex) Pretty ¶ added in v8.14.0
func (r *ResolveIndex) Pretty(pretty bool) *ResolveIndex
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type Response ¶ added in v8.7.0
type Response struct {
Aliases []types.ResolveIndexAliasItem `json:"aliases"`
DataStreams []types.ResolveIndexDataStreamsItem `json:"data_streams"`
Indices []types.ResolveIndexItem `json:"indices"`
}
Response holds the response body struct for the package resolveindex
Source Files