Documentation
¶
Overview ¶
Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
Index ¶
- Variables
- type NewResolveCluster
- type ResolveCluster
- func (r *ResolveCluster) AllowNoIndices(allownoindices bool) *ResolveCluster
- func (r ResolveCluster) Do(providedCtx context.Context) (Response, error)
- func (r *ResolveCluster) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *ResolveCluster
- func (r *ResolveCluster) Header(key, value string) *ResolveCluster
- func (r *ResolveCluster) HttpRequest(ctx context.Context) (*http.Request, error)
- 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)
- 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 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
Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
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) 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) Header ¶
func (r *ResolveCluster) Header(key, value string) *ResolveCluster
Header set a key, value pair in the ResolveCluster headers map.
func (*ResolveCluster) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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
type Response ¶
type Response map[string]types.ResolveClusterInfo
Source Files