promotedatastream

Documentation

Overview

Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

Index

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

type NewPromoteDataStream func(name string) *PromoteDataStream

NewPromoteDataStream type alias for index.

func NewPromoteDataStreamFunc

func NewPromoteDataStreamFunc(tp elastictransport.Interface) NewPromoteDataStream

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

type PromoteDataStream

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

func New

func New(tp elastictransport.Interface) *PromoteDataStream

Promotes a data stream from a replicated data stream managed by CCR to a regular data stream

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

func (PromoteDataStream) Do

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

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

func (*PromoteDataStream) Header

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

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

func (*PromoteDataStream) HttpRequest

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

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

func (PromoteDataStream) IsSuccess

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

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

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

type Response

type Response = json.RawMessage

func NewResponse

func NewResponse() *Response