deletenode

Documentation

Overview

Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

Index

• Variables
• type DeleteNode
  • func New(tp elastictransport.Interface) *DeleteNode
  • func (r DeleteNode) Do(ctx context.Context) (*Response, error)
  • func (r *DeleteNode) Header(key, value string) *DeleteNode
  • func (r *DeleteNode) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteNode) IsSuccess(ctx context.Context) (bool, error)
  • func (r *DeleteNode) MasterTimeout(enum timeunit.TimeUnit) *DeleteNode
  • func (r *DeleteNode) NodeId(v string) *DeleteNode
  • func (r DeleteNode) Perform(ctx context.Context) (*http.Response, error)
  • func (r *DeleteNode) Timeout(enum timeunit.TimeUnit) *DeleteNode
• type NewDeleteNode
  • func NewDeleteNodeFunc(tp elastictransport.Interface) NewDeleteNode
• 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 DeleteNode

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

func New

func New(tp elastictransport.Interface) *DeleteNode

Removes a node from the shutdown list. Designed for indirect use by ECE/ESS and ECK. Direct use is not supported.

https://www.elastic.co/guide/en/elasticsearch/reference/current

func (DeleteNode) Do

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

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

func (*DeleteNode) Header

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

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

func (*DeleteNode) HttpRequest

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

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

func (DeleteNode) IsSuccess

func (r DeleteNode) IsSuccess(ctx 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 (*DeleteNode) MasterTimeout

func (r *DeleteNode) MasterTimeout(enum timeunit.TimeUnit) *DeleteNode

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (*DeleteNode) NodeId

func (r *DeleteNode) NodeId(v string) *DeleteNode

NodeId The node id of node to be removed from the shutdown state API Name: nodeid

func (DeleteNode) Perform

func (r DeleteNode) Perform(ctx context.Context) (*http.Response, error)

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

func (*DeleteNode) Timeout

func (r *DeleteNode) Timeout(enum timeunit.TimeUnit) *DeleteNode

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

type NewDeleteNode

type NewDeleteNode func(nodeid string) *DeleteNode

NewDeleteNode type alias for index.

func NewDeleteNodeFunc

func NewDeleteNodeFunc(tp elastictransport.Interface) NewDeleteNode

NewDeleteNodeFunc returns a new instance of DeleteNode 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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response