Documentation
¶
Overview ¶
Returns information about the indices and shards that a search request would be executed against.
Index ¶
- Variables
- type NewSearchShards
- type Response
- type SearchShards
- func (r *SearchShards) AllowNoIndices(allownoindices bool) *SearchShards
- func (r SearchShards) Do(providedCtx context.Context) (*Response, error)
- func (r *SearchShards) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *SearchShards
- func (r *SearchShards) Header(key, value string) *SearchShards
- func (r *SearchShards) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *SearchShards) IgnoreUnavailable(ignoreunavailable bool) *SearchShards
- func (r *SearchShards) Index(index string) *SearchShards
- func (r SearchShards) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *SearchShards) Local(local bool) *SearchShards
- func (r SearchShards) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *SearchShards) Preference(preference string) *SearchShards
- func (r *SearchShards) Routing(routing string) *SearchShards
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 NewSearchShards ¶
type NewSearchShards func() *SearchShards
NewSearchShards type alias for index.
func NewSearchShardsFunc ¶
func NewSearchShardsFunc(tp elastictransport.Interface) NewSearchShards
NewSearchShardsFunc returns a new instance of SearchShards 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 {
Indices map[string]types.ShardStoreIndex `json:"indices"`
Nodes map[string]types.NodeAttributes `json:"nodes"`
Shards [][]types.NodeShard `json:"shards"`
}
Response holds the response body struct for the package searchshards
type SearchShards ¶
type SearchShards struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *SearchShards
Returns information about the indices and shards that a search request would be executed against.
https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html
func (*SearchShards) AllowNoIndices ¶
func (r *SearchShards) AllowNoIndices(allownoindices bool) *SearchShards
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 (SearchShards) Do ¶
func (r SearchShards) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a searchshards.Response
func (*SearchShards) ExpandWildcards ¶
func (r *SearchShards) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *SearchShards
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 (*SearchShards) Header ¶
func (r *SearchShards) Header(key, value string) *SearchShards
Header set a key, value pair in the SearchShards headers map.
func (*SearchShards) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*SearchShards) IgnoreUnavailable ¶
func (r *SearchShards) IgnoreUnavailable(ignoreunavailable bool) *SearchShards
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*SearchShards) Index ¶
func (r *SearchShards) Index(index string) *SearchShards
Index Returns the indices and shards that a search request would be executed against. API Name: index
func (SearchShards) IsSuccess ¶
func (r SearchShards) 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 (*SearchShards) Local ¶
func (r *SearchShards) Local(local bool) *SearchShards
Local If `true`, the request retrieves information from the local node only. API name: local
func (SearchShards) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*SearchShards) Preference ¶
func (r *SearchShards) Preference(preference string) *SearchShards
Preference Specifies the node or shard the operation should be performed on. Random by default. API name: preference
func (*SearchShards) Routing ¶
func (r *SearchShards) Routing(routing string) *SearchShards
Routing Custom value used to route operations to a specific shard. API name: routing
Source Files