Documentation
¶
Overview ¶
Returns information about whether a particular index exists.
Index ¶
- Variables
- type Exists
- func (r *Exists) AllowNoIndices(allownoindices bool) *Exists
- func (r Exists) Do(ctx context.Context) (bool, error)
- func (r *Exists) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Exists
- func (r *Exists) FlatSettings(flatsettings bool) *Exists
- func (r *Exists) Header(key, value string) *Exists
- func (r *Exists) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *Exists) IgnoreUnavailable(ignoreunavailable bool) *Exists
- func (r *Exists) IncludeDefaults(includedefaults bool) *Exists
- func (r Exists) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *Exists) Local(local bool) *Exists
- func (r Exists) Perform(providedCtx context.Context) (*http.Response, error)
- type NewExists
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 Exists ¶
type Exists struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *Exists
Returns information about whether a particular index exists.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html
func (*Exists) 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 (Exists) Do ¶
Do runs the request through the transport, handle the response and returns a exists.Response
func (*Exists) ExpandWildcards ¶
func (r *Exists) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Exists
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 (*Exists) FlatSettings ¶
FlatSettings If `true`, returns settings in flat format. API name: flat_settings
func (*Exists) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*Exists) IgnoreUnavailable ¶
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*Exists) IncludeDefaults ¶
IncludeDefaults If `true`, return all default settings in the response. API name: include_defaults
func (Exists) 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.
type NewExists ¶
NewExists type alias for index.
func NewExistsFunc ¶
func NewExistsFunc(tp elastictransport.Interface) NewExists
NewExistsFunc returns a new instance of Exists with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
Source Files