delete

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: 14 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(allownoindices bool) *Delete

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 (Delete) Do

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

Do runs the request through the transport, handle the response and returns a delete.Response

func (*Delete) ExpandWildcards

func (r *Delete) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Delete

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 (*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(ignoreunavailable bool) *Delete

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

func (*Delete) Index

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

Index Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. 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(duration string) *Delete

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

func (Delete) Perform added in v8.7.0

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

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

func (*Delete) Timeout

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

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. 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.

type Response added in v8.7.0

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool                   `json:"acknowledged"`
	Shards_      *types.ShardStatistics `json:"_shards,omitempty"`
}

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

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