exists

package
v8.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2023 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Overview

Returns information about whether a particular index exists.

Index

Constants

This section is empty.

Variables

View Source
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

Returns information about whether a particular index exists.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-exists.html

func (*Exists) AllowNoIndices

func (r *Exists) AllowNoIndices(allownoindices bool) *Exists

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

func (r Exists) Do(ctx context.Context) (bool, error)

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

func (r *Exists) FlatSettings(flatsettings bool) *Exists

FlatSettings If `true`, returns settings in flat format. API name: flat_settings

func (*Exists) Header

func (r *Exists) Header(key, value string) *Exists

Header set a key, value pair in the Exists headers map.

func (*Exists) HttpRequest

func (r *Exists) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*Exists) IgnoreUnavailable

func (r *Exists) IgnoreUnavailable(ignoreunavailable bool) *Exists

IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable

func (*Exists) IncludeDefaults

func (r *Exists) IncludeDefaults(includedefaults bool) *Exists

IncludeDefaults If `true`, return all default settings in the response. API name: include_defaults

func (*Exists) Index

func (r *Exists) Index(index string) *Exists

Index Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). API Name: index

func (Exists) IsSuccess

func (r Exists) IsSuccess(ctx 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 (*Exists) Local

func (r *Exists) Local(local bool) *Exists

Local If `true`, the request retrieves information from the local node only. API name: local

func (Exists) Perform added in v8.7.0

func (r Exists) Perform(ctx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

type NewExists

type NewExists func(index string) *Exists

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL