migratetodatastream

Documentation

Overview

Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

Index

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

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

func New

func New(tp elastictransport.Interface) *MigrateToDataStream

Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.

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

func (MigrateToDataStream) Do

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

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

func (*MigrateToDataStream) ErrorTrace

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

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

func (*MigrateToDataStream) FilterPath

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

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

func (*MigrateToDataStream) Header

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

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

func (*MigrateToDataStream) HttpRequest

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

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

func (*MigrateToDataStream) Human

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

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

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

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

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

func (*MigrateToDataStream) Pretty

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

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

type NewMigrateToDataStream

type NewMigrateToDataStream func(name string) *MigrateToDataStream

NewMigrateToDataStream type alias for index.

func NewMigrateToDataStreamFunc

func NewMigrateToDataStreamFunc(tp elastictransport.Interface) NewMigrateToDataStream

NewMigrateToDataStreamFunc returns a new instance of MigrateToDataStream 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 migratetodatastream

https://github.com/elastic/elasticsearch-specification/blob/19027dbdd366978ccae41842a040a636730e7c10/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response