delete

package
v8.6.0 Latest Latest
Warning

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

Go to latest
Published: Jan 11, 2023 License: Apache-2.0 Imports: 11 Imported by: 5

Documentation

Overview

Deletes an index.

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 Delete

type Delete struct {
	// contains filtered or unexported fields
}

func (*Delete) AllowNoIndices

func (r *Delete) AllowNoIndices(b bool) *Delete

AllowNoIndices Ignore if a wildcard expression resolves to no concrete indices (default: false) API name: allow_no_indices

func (Delete) Do

func (r Delete) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*Delete) ExpandWildcards

func (r *Delete) ExpandWildcards(value string) *Delete

ExpandWildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices API name: expand_wildcards

func (*Delete) Header

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

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

func (*Delete) HttpRequest

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

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

func (*Delete) IgnoreUnavailable

func (r *Delete) IgnoreUnavailable(b bool) *Delete

IgnoreUnavailable Ignore unavailable indexes (default: false) API name: ignore_unavailable

func (*Delete) Index

func (r *Delete) Index(v string) *Delete

Index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices API Name: index

func (Delete) IsSuccess

func (r Delete) 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 (*Delete) MasterTimeout

func (r *Delete) MasterTimeout(value string) *Delete

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*Delete) Timeout

func (r *Delete) Timeout(value string) *Delete

Timeout Explicit operation timeout API name: timeout

type NewDelete

type NewDelete func(index string) *Delete

NewDelete type alias for index.

func NewDeleteFunc

func NewDeleteFunc(tp elastictransport.Interface) NewDelete

NewDeleteFunc returns a new instance of Delete 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