Documentation
¶
Overview ¶
Provides low-level information about segments in a Lucene index.
Index ¶
- Variables
- type NewSegments
- type Response
- type Segments
- func (r *Segments) AllowNoIndices(allownoindices bool) *Segments
- func (r Segments) Do(providedCtx context.Context) (*Response, error)
- func (r *Segments) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Segments
- func (r *Segments) Header(key, value string) *Segments
- func (r *Segments) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Segments) IgnoreUnavailable(ignoreunavailable bool) *Segments
- func (r *Segments) Index(index string) *Segments
- func (r Segments) IsSuccess(providedCtx context.Context) (bool, error)
- func (r Segments) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *Segments) Verbose(verbose bool) *Segments
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 NewSegments ¶
type NewSegments func() *Segments
NewSegments type alias for index.
func NewSegmentsFunc ¶
func NewSegmentsFunc(tp elastictransport.Interface) NewSegments
NewSegmentsFunc returns a new instance of Segments 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.IndexSegment `json:"indices"`
Shards_ types.ShardStatistics `json:"_shards"`
}
Response holds the response body struct for the package segments
type Segments ¶
type Segments struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Segments
Provides low-level information about segments in a Lucene index.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html
func (*Segments) AllowNoIndices ¶
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. API name: allow_no_indices
func (Segments) Do ¶
Do runs the request through the transport, handle the response and returns a segments.Response
func (*Segments) ExpandWildcards ¶
func (r *Segments) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Segments
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 (*Segments) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Segments) IgnoreUnavailable ¶
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*Segments) Index ¶
Index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
func (Segments) IsSuccess ¶
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.
Source Files