resolvecluster

Documentation

Overview

Resolve the cluster. Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.

This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.

You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint.

For each cluster in the index expression, information is returned about:

* Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`. * Whether there are any indices, aliases, or data streams on that cluster that match the index expression. * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). * Cluster version information, including the Elasticsearch server version.

Index

• Variables
• type NewResolveCluster
  • func NewResolveClusterFunc(tp elastictransport.Interface) NewResolveCluster
• type ResolveCluster
  • func New(tp elastictransport.Interface) *ResolveCluster
  • func (r *ResolveCluster) AllowNoIndices(allownoindices bool) *ResolveCluster
  • func (r ResolveCluster) Do(providedCtx context.Context) (Response, error)
  • func (r *ResolveCluster) ErrorTrace(errortrace bool) *ResolveCluster
  • func (r *ResolveCluster) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ResolveCluster
  • func (r *ResolveCluster) FilterPath(filterpaths ...string) *ResolveCluster
  • func (r *ResolveCluster) Header(key, value string) *ResolveCluster
  • func (r *ResolveCluster) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ResolveCluster) Human(human bool) *ResolveCluster
  • func (r *ResolveCluster) IgnoreThrottled(ignorethrottled bool) *ResolveCluster
  • func (r *ResolveCluster) IgnoreUnavailable(ignoreunavailable bool) *ResolveCluster
  • func (r ResolveCluster) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r ResolveCluster) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ResolveCluster) Pretty(pretty bool) *ResolveCluster
• 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 NewResolveCluster

type NewResolveCluster func(name string) *ResolveCluster

NewResolveCluster type alias for index.

func NewResolveClusterFunc

func NewResolveClusterFunc(tp elastictransport.Interface) NewResolveCluster

NewResolveClusterFunc returns a new instance of ResolveCluster with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type ResolveCluster

type ResolveCluster struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *ResolveCluster

Resolve the cluster. Resolve the specified index expressions to return information about each cluster, including the local cluster, if included. Multiple patterns and remote clusters are supported.

This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search.

You use the same index expression with this endpoint as you would for cross-cluster search. Index and cluster exclusions are also supported with this endpoint.

For each cluster in the index expression, information is returned about:

* Whether the querying ("local") cluster is currently connected to each remote cluster in the index expression scope. * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`. * Whether there are any indices, aliases, or data streams on that cluster that match the index expression. * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). * Cluster version information, including the Elasticsearch server version.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-cluster-api.html

func (*ResolveCluster) AllowNoIndices

func (r *ResolveCluster) AllowNoIndices(allownoindices bool) *ResolveCluster

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

func (r ResolveCluster) Do(providedCtx context.Context) (Response, error)

Do runs the request through the transport, handle the response and returns a resolvecluster.Response

func (*ResolveCluster) ErrorTrace

func (r *ResolveCluster) ErrorTrace(errortrace bool) *ResolveCluster

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*ResolveCluster) ExpandWildcards

func (r *ResolveCluster) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ResolveCluster

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 (*ResolveCluster) FilterPath

func (r *ResolveCluster) FilterPath(filterpaths ...string) *ResolveCluster

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*ResolveCluster) Header

func (r *ResolveCluster) Header(key, value string) *ResolveCluster

Header set a key, value pair in the ResolveCluster headers map.

func (*ResolveCluster) HttpRequest

func (r *ResolveCluster) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*ResolveCluster) Human

func (r *ResolveCluster) Human(human bool) *ResolveCluster

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 (*ResolveCluster) IgnoreThrottled

func (r *ResolveCluster) IgnoreThrottled(ignorethrottled bool) *ResolveCluster

IgnoreThrottled If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false. API name: ignore_throttled

func (*ResolveCluster) IgnoreUnavailable

func (r *ResolveCluster) IgnoreUnavailable(ignoreunavailable bool) *ResolveCluster

IgnoreUnavailable If false, the request returns an error if it targets a missing or closed index. Defaults to false. API name: ignore_unavailable

func (ResolveCluster) IsSuccess

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

func (r ResolveCluster) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*ResolveCluster) Pretty

func (r *ResolveCluster) Pretty(pretty bool) *ResolveCluster

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

type Response

type Response map[string]types.ResolveClusterInfo

func NewResponse

func NewResponse() Response

NewResponse returns a Response