deletedanglingindex

Documentation

Overview

Deletes the specified dangling index

Index

• Variables
• type DeleteDanglingIndex
  • func New(tp elastictransport.Interface) *DeleteDanglingIndex
  • func (r *DeleteDanglingIndex) AcceptDataLoss(acceptdataloss bool) *DeleteDanglingIndex
  • func (r DeleteDanglingIndex) Do(providedCtx context.Context) (*Response, error)
  • func (r *DeleteDanglingIndex) ErrorTrace(errortrace bool) *DeleteDanglingIndex
  • func (r *DeleteDanglingIndex) FilterPath(filterpaths ...string) *DeleteDanglingIndex
  • func (r *DeleteDanglingIndex) Header(key, value string) *DeleteDanglingIndex
  • func (r *DeleteDanglingIndex) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *DeleteDanglingIndex) Human(human bool) *DeleteDanglingIndex
  • func (r DeleteDanglingIndex) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *DeleteDanglingIndex) MasterTimeout(duration string) *DeleteDanglingIndex
  • func (r DeleteDanglingIndex) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *DeleteDanglingIndex) Pretty(pretty bool) *DeleteDanglingIndex
  • func (r *DeleteDanglingIndex) Timeout(duration string) *DeleteDanglingIndex
• type NewDeleteDanglingIndex
  • func NewDeleteDanglingIndexFunc(tp elastictransport.Interface) NewDeleteDanglingIndex
• 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 DeleteDanglingIndex

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

func New

func New(tp elastictransport.Interface) *DeleteDanglingIndex

Deletes the specified dangling index

https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html

func (*DeleteDanglingIndex) AcceptDataLoss

func (r *DeleteDanglingIndex) AcceptDataLoss(acceptdataloss bool) *DeleteDanglingIndex

AcceptDataLoss Must be set to true in order to delete the dangling index API name: accept_data_loss

func (DeleteDanglingIndex) Do

func (r DeleteDanglingIndex) Do(providedCtx context.Context) (*Response, error)

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

func (*DeleteDanglingIndex) ErrorTrace

func (r *DeleteDanglingIndex) ErrorTrace(errortrace bool) *DeleteDanglingIndex

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*DeleteDanglingIndex) FilterPath

func (r *DeleteDanglingIndex) FilterPath(filterpaths ...string) *DeleteDanglingIndex

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*DeleteDanglingIndex) Header

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

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

func (*DeleteDanglingIndex) HttpRequest

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

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

func (*DeleteDanglingIndex) Human

func (r *DeleteDanglingIndex) Human(human bool) *DeleteDanglingIndex

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (DeleteDanglingIndex) IsSuccess

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

func (r *DeleteDanglingIndex) MasterTimeout(duration string) *DeleteDanglingIndex

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (DeleteDanglingIndex) Perform

func (r DeleteDanglingIndex) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*DeleteDanglingIndex) Pretty

func (r *DeleteDanglingIndex) Pretty(pretty bool) *DeleteDanglingIndex

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*DeleteDanglingIndex) Timeout

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

Timeout Explicit operation timeout API name: timeout

type NewDeleteDanglingIndex

type NewDeleteDanglingIndex func(indexuuid string) *DeleteDanglingIndex

NewDeleteDanglingIndex type alias for index.

func NewDeleteDanglingIndexFunc

func NewDeleteDanglingIndexFunc(tp elastictransport.Interface) NewDeleteDanglingIndex

NewDeleteDanglingIndexFunc returns a new instance of DeleteDanglingIndex 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"`
}

Response holds the response body struct for the package deletedanglingindex

https://github.com/elastic/elasticsearch-specification/blob/07bf82537a186562d8699685e3704ea338b268ef/specification/dangling_indices/delete_dangling_index/DeleteDanglingIndexResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response