movetostep

package
v8.14.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type MoveToStep

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

func New

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) CurrentStep

func (r *MoveToStep) CurrentStep(currentstep *types.StepKey) *MoveToStep

API name: current_step

func (MoveToStep) Do

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

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

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) NextStep

func (r *MoveToStep) NextStep(nextstep *types.StepKey) *MoveToStep

API name: next_step

func (MoveToStep) Perform

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

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

func (*MoveToStep) Raw

func (r *MoveToStep) Raw(raw io.Reader) *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/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ilm/move_to_step/MoveToStepRequest.ts#L24-L36

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

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 movetostep

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/ilm/move_to_step/MoveToStepResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL