Documentation
¶
Overview ¶
Returns information about one or more indices.
Index ¶
- Variables
- type Get
- func (r *Get) AllowNoIndices(allownoindices bool) *Get
- func (r Get) Do(providedCtx context.Context) (Response, error)
- func (r *Get) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Get
- func (r *Get) Features(features ...feature.Feature) *Get
- func (r *Get) FlatSettings(flatsettings bool) *Get
- func (r *Get) Header(key, value string) *Get
- func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Get) IgnoreUnavailable(ignoreunavailable bool) *Get
- func (r *Get) IncludeDefaults(includedefaults bool) *Get
- func (r Get) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Get) Local(local bool) *Get
- func (r *Get) MasterTimeout(duration string) *Get
- func (r Get) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGet
- 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 Get ¶
type Get struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Get
Returns information about one or more indices.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html
func (*Get) 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. 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 (Get) Do ¶
Do runs the request through the transport, handle the response and returns a get.Response
func (*Get) ExpandWildcards ¶
func (r *Get) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Get
ExpandWildcards Type of index that wildcard expressions 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. API name: expand_wildcards
func (*Get) Features ¶
Features Return only information on specified index features API name: features
func (*Get) FlatSettings ¶
FlatSettings If true, returns settings in flat format. API name: flat_settings
func (*Get) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Get) IgnoreUnavailable ¶
IgnoreUnavailable If false, requests that target a missing index return an error. API name: ignore_unavailable
func (*Get) IncludeDefaults ¶
IncludeDefaults If true, return all default settings in the response. API name: include_defaults
func (Get) 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.
func (*Get) Local ¶
Local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. API name: local
func (*Get) MasterTimeout ¶
MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout
type NewGet ¶
NewGet type alias for index.
func NewGetFunc ¶
func NewGetFunc(tp elastictransport.Interface) NewGet
NewGetFunc returns a new instance of Get 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 map[string]types.IndexState
Source Files