importdanglingindex

Documentation

Overview

Imports the specified dangling index

Index

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

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

func New

func New(tp elastictransport.Interface) *ImportDanglingIndex

Imports the specified dangling index

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

func (*ImportDanglingIndex) AcceptDataLoss

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

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

func (ImportDanglingIndex) Do

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

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

func (*ImportDanglingIndex) ErrorTrace

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

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

func (*ImportDanglingIndex) FilterPath

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

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

func (*ImportDanglingIndex) Header

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

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

func (*ImportDanglingIndex) HttpRequest

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

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

func (*ImportDanglingIndex) Human

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

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

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

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

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (ImportDanglingIndex) Perform

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

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

func (*ImportDanglingIndex) Pretty

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

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

func (*ImportDanglingIndex) Timeout

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

Timeout Explicit operation timeout API name: timeout

type NewImportDanglingIndex

type NewImportDanglingIndex func(indexuuid string) *ImportDanglingIndex

NewImportDanglingIndex type alias for index.

func NewImportDanglingIndexFunc

func NewImportDanglingIndexFunc(tp elastictransport.Interface) NewImportDanglingIndex

NewImportDanglingIndexFunc returns a new instance of ImportDanglingIndex 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 importdanglingindex

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/dangling_indices/import_dangling_index/ImportDanglingIndexResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response