getmigratereindexstatus

Documentation

Overview

Get the migration reindexing status.

Get the status of a migration reindex attempt for a data stream or index.

Index

• Variables
• type GetMigrateReindexStatus
  • func New(tp elastictransport.Interface) *GetMigrateReindexStatus
  • func (r GetMigrateReindexStatus) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetMigrateReindexStatus) ErrorTrace(errortrace bool) *GetMigrateReindexStatus
  • func (r *GetMigrateReindexStatus) FilterPath(filterpaths ...string) *GetMigrateReindexStatus
  • func (r *GetMigrateReindexStatus) Header(key, value string) *GetMigrateReindexStatus
  • func (r *GetMigrateReindexStatus) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetMigrateReindexStatus) Human(human bool) *GetMigrateReindexStatus
  • func (r GetMigrateReindexStatus) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r GetMigrateReindexStatus) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetMigrateReindexStatus) Pretty(pretty bool) *GetMigrateReindexStatus
• type NewGetMigrateReindexStatus
  • func NewGetMigrateReindexStatusFunc(tp elastictransport.Interface) NewGetMigrateReindexStatus
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error

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 GetMigrateReindexStatus

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

func New

func New(tp elastictransport.Interface) *GetMigrateReindexStatus

Get the migration reindexing status.

Get the status of a migration reindex attempt for a data stream or index.

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

func (GetMigrateReindexStatus) Do

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

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

func (*GetMigrateReindexStatus) ErrorTrace

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

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

func (*GetMigrateReindexStatus) FilterPath

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

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

func (*GetMigrateReindexStatus) Header

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

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

func (*GetMigrateReindexStatus) HttpRequest

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

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

func (*GetMigrateReindexStatus) Human

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

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

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

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

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

func (*GetMigrateReindexStatus) Pretty

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

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

type NewGetMigrateReindexStatus

type NewGetMigrateReindexStatus func(index string) *GetMigrateReindexStatus

NewGetMigrateReindexStatus type alias for index.

func NewGetMigrateReindexStatusFunc

func NewGetMigrateReindexStatusFunc(tp elastictransport.Interface) NewGetMigrateReindexStatus

NewGetMigrateReindexStatusFunc returns a new instance of GetMigrateReindexStatus 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 {
	Complete                     bool                     `json:"complete"`
	Errors                       []types.StatusError      `json:"errors"`
	Exception                    *string                  `json:"exception,omitempty"`
	InProgress                   []types.StatusInProgress `json:"in_progress"`
	Pending                      int                      `json:"pending"`
	StartTime                    types.DateTime           `json:"start_time,omitempty"`
	StartTimeMillis              int64                    `json:"start_time_millis"`
	Successes                    int                      `json:"successes"`
	TotalIndicesInDataStream     int                      `json:"total_indices_in_data_stream"`
	TotalIndicesRequiringUpgrade int                      `json:"total_indices_requiring_upgrade"`
}

Response holds the response body struct for the package getmigratereindexstatus

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/get_migrate_reindex_status/MigrateGetReindexStatusResponse.ts#L23-L36

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

func (s *Response) UnmarshalJSON(data []byte) error