migratetodatastream

Documentation

Overview

Migrates an alias to a data stream

Index

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

Migrates an alias to a data 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) 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) 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.

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/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response