migratereindex

Documentation

Overview

Reindex legacy backing indices.

Reindex all legacy backing indices for a data stream. This operation occurs in a persistent task. The persistent task ID is returned immediately and the reindexing work is completed in that task.

Index

• Variables
• type MigrateReindex
  • func New(tp elastictransport.Interface) *MigrateReindex
  • func (r MigrateReindex) Do(providedCtx context.Context) (*Response, error)
  • func (r *MigrateReindex) ErrorTrace(errortrace bool) *MigrateReindex
  • func (r *MigrateReindex) FilterPath(filterpaths ...string) *MigrateReindex
  • func (r *MigrateReindex) Header(key, value string) *MigrateReindex
  • func (r *MigrateReindex) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *MigrateReindex) Human(human bool) *MigrateReindex
  • func (r *MigrateReindex) Mode(mode modeenum.ModeEnum) *MigrateReindex
  • func (r MigrateReindex) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *MigrateReindex) Pretty(pretty bool) *MigrateReindex
  • func (r *MigrateReindex) Raw(raw io.Reader) *MigrateReindex
  • func (r *MigrateReindex) Request(req *Request) *MigrateReindex
  • func (r *MigrateReindex) Source(source *types.SourceIndex) *MigrateReindex
• type NewMigrateReindex
  • func NewMigrateReindexFunc(tp elastictransport.Interface) NewMigrateReindex
• type Request
  • func NewRequest() *Request
• 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 MigrateReindex

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

func New

func New(tp elastictransport.Interface) *MigrateReindex

Reindex legacy backing indices.

Reindex all legacy backing indices for a data stream. This operation occurs in a persistent task. The persistent task ID is returned immediately and the reindexing work is completed in that task.

https://www.elastic.co/guide/en/elasticsearch/reference/current/migrate-data-stream.html

func (MigrateReindex) Do

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

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

func (*MigrateReindex) ErrorTrace

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

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

func (*MigrateReindex) FilterPath

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

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

func (*MigrateReindex) Header

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

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

func (*MigrateReindex) HttpRequest

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

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

func (*MigrateReindex) Human

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

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 (*MigrateReindex) Mode

func (r *MigrateReindex) Mode(mode modeenum.ModeEnum) *MigrateReindex

Mode Reindex mode. Currently only 'upgrade' is supported. API name: mode

func (MigrateReindex) Perform

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

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

func (*MigrateReindex) Pretty

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

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

func (*MigrateReindex) Raw

func (r *MigrateReindex) Raw(raw io.Reader) *MigrateReindex

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*MigrateReindex) Request

func (r *MigrateReindex) Request(req *Request) *MigrateReindex

Request allows to set the request property with the appropriate payload.

func (*MigrateReindex) Source

func (r *MigrateReindex) Source(source *types.SourceIndex) *MigrateReindex

Source The source index or data stream (only data streams are currently supported). API name: source

type NewMigrateReindex

type NewMigrateReindex func() *MigrateReindex

NewMigrateReindex type alias for index.

func NewMigrateReindexFunc

func NewMigrateReindexFunc(tp elastictransport.Interface) NewMigrateReindex

NewMigrateReindexFunc returns a new instance of MigrateReindex with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request = types.MigrateReindex

Request holds the request body struct for the package migratereindex

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/indices/migrate_reindex/MigrateReindexRequest.ts#L23-L37

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

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 migratereindex

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/indices/migrate_reindex/MigrateReindexResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response