movetostep

Documentation

Overview

Manually moves an index into the specified step and executes that step.

Index

• Variables
• type MoveToStep
  • func New(tp elastictransport.Interface) *MoveToStep
  • func (r MoveToStep) Do(ctx context.Context) (*http.Response, error)
  • func (r *MoveToStep) Header(key, value string) *MoveToStep
  • func (r *MoveToStep) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *MoveToStep) Index(v string) *MoveToStep
  • func (r *MoveToStep) Raw(raw json.RawMessage) *MoveToStep
  • func (r *MoveToStep) Request(req *Request) *MoveToStep
• type NewMoveToStep
  • func NewMoveToStepFunc(tp elastictransport.Interface) NewMoveToStep
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) CurrentStep(currentstep *types.StepKeyBuilder) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) NextStep(nextstep *types.StepKeyBuilder) *RequestBuilder

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 MoveToStep

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

func New

func New(tp elastictransport.Interface) *MoveToStep

Manually moves an index into the specified step and executes that step.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html

func (MoveToStep) Do

func (r MoveToStep) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*MoveToStep) Header

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

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

func (*MoveToStep) HttpRequest

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

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

func (*MoveToStep) Index

func (r *MoveToStep) Index(v string) *MoveToStep

Index The name of the index whose lifecycle step is to change API Name: index

func (*MoveToStep) Raw

func (r *MoveToStep) Raw(raw json.RawMessage) *MoveToStep

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

func (*MoveToStep) Request

func (r *MoveToStep) Request(req *Request) *MoveToStep

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

type NewMoveToStep

type NewMoveToStep func(index string) *MoveToStep

NewMoveToStep type alias for index.

func NewMoveToStepFunc

func NewMoveToStepFunc(tp elastictransport.Interface) NewMoveToStep

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

type Request

type Request struct {
	CurrentStep *types.StepKey `json:"current_step,omitempty"`

	NextStep *types.StepKey `json:"next_step,omitempty"`
}

Request holds the request body struct for the package movetostep

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ilm/move_to_step/MoveToStepRequest.ts#L24-L37

type RequestBuilder

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

RequestBuilder is the builder API for the movetostep.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) CurrentStep

func (rb *RequestBuilder) CurrentStep(currentstep *types.StepKeyBuilder) *RequestBuilder

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) NextStep

func (rb *RequestBuilder) NextStep(nextstep *types.StepKeyBuilder) *RequestBuilder