delete

Documentation

Overview

Deletes an index.

Index

• Variables
• type Delete
  • func New(tp elastictransport.Interface) *Delete
  • func (r *Delete) AllowNoIndices(allownoindices bool) *Delete
  • func (r Delete) Do(providedCtx context.Context) (*Response, error)
  • func (r *Delete) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *Delete
  • func (r *Delete) Header(key, value string) *Delete
  • func (r *Delete) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Delete) IgnoreUnavailable(ignoreunavailable bool) *Delete
  • func (r Delete) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *Delete) MasterTimeout(duration string) *Delete
  • func (r Delete) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Delete) Timeout(duration string) *Delete
• type NewDelete
  • func NewDeleteFunc(tp elastictransport.Interface) NewDelete
• type Response
  • func NewResponse() *Response

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.

Types

type Delete

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

func New

func New(tp elastictransport.Interface) *Delete

Deletes an index.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html

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(providedCtx 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) IsSuccess

func (r Delete) IsSuccess(providedCtx 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

func (r Delete) Perform(providedCtx 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

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"`
}

Response holds the response body struct for the package delete

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/delete/IndicesDeleteResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response