forgetfollower

Documentation

Overview

Removes the follower retention leases from the leader.

Index

• Variables
• type ForgetFollower
  • func New(tp elastictransport.Interface) *ForgetFollower
  • func (r ForgetFollower) Do(providedCtx context.Context) (*Response, error)
  • func (r *ForgetFollower) ErrorTrace(errortrace bool) *ForgetFollower
  • func (r *ForgetFollower) FilterPath(filterpaths ...string) *ForgetFollower
  • func (r *ForgetFollower) FollowerCluster(followercluster string) *ForgetFollower
  • func (r *ForgetFollower) FollowerIndex(indexname string) *ForgetFollower
  • func (r *ForgetFollower) FollowerIndexUuid(uuid string) *ForgetFollower
  • func (r *ForgetFollower) Header(key, value string) *ForgetFollower
  • func (r *ForgetFollower) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ForgetFollower) Human(human bool) *ForgetFollower
  • func (r *ForgetFollower) LeaderRemoteCluster(leaderremotecluster string) *ForgetFollower
  • func (r ForgetFollower) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ForgetFollower) Pretty(pretty bool) *ForgetFollower
  • func (r *ForgetFollower) Raw(raw io.Reader) *ForgetFollower
  • func (r *ForgetFollower) Request(req *Request) *ForgetFollower
• type NewForgetFollower
  • func NewForgetFollowerFunc(tp elastictransport.Interface) NewForgetFollower
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) 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 ForgetFollower

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

func New

func New(tp elastictransport.Interface) *ForgetFollower

Removes the follower retention leases from the leader.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html

func (ForgetFollower) Do

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

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

func (*ForgetFollower) ErrorTrace

func (r *ForgetFollower) ErrorTrace(errortrace bool) *ForgetFollower

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*ForgetFollower) FilterPath

func (r *ForgetFollower) FilterPath(filterpaths ...string) *ForgetFollower

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*ForgetFollower) FollowerCluster

func (r *ForgetFollower) FollowerCluster(followercluster string) *ForgetFollower

API name: follower_cluster

func (*ForgetFollower) FollowerIndex

func (r *ForgetFollower) FollowerIndex(indexname string) *ForgetFollower

API name: follower_index

func (*ForgetFollower) FollowerIndexUuid

func (r *ForgetFollower) FollowerIndexUuid(uuid string) *ForgetFollower

API name: follower_index_uuid

func (*ForgetFollower) Header

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

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

func (*ForgetFollower) HttpRequest

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

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

func (*ForgetFollower) Human

func (r *ForgetFollower) Human(human bool) *ForgetFollower

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*ForgetFollower) LeaderRemoteCluster

func (r *ForgetFollower) LeaderRemoteCluster(leaderremotecluster string) *ForgetFollower

API name: leader_remote_cluster

func (ForgetFollower) Perform

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

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

func (*ForgetFollower) Pretty

func (r *ForgetFollower) Pretty(pretty bool) *ForgetFollower

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*ForgetFollower) Raw

func (r *ForgetFollower) Raw(raw io.Reader) *ForgetFollower

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

func (*ForgetFollower) Request

func (r *ForgetFollower) Request(req *Request) *ForgetFollower

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

type NewForgetFollower

type NewForgetFollower func(index string) *ForgetFollower

NewForgetFollower type alias for index.

func NewForgetFollowerFunc

func NewForgetFollowerFunc(tp elastictransport.Interface) NewForgetFollower

NewForgetFollowerFunc returns a new instance of ForgetFollower 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 {
	FollowerCluster     *string `json:"follower_cluster,omitempty"`
	FollowerIndex       *string `json:"follower_index,omitempty"`
	FollowerIndexUuid   *string `json:"follower_index_uuid,omitempty"`
	LeaderRemoteCluster *string `json:"leader_remote_cluster,omitempty"`
}

Request holds the request body struct for the package forgetfollower

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L38

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Shards_ types.ShardStatistics `json:"_shards"`
}

Response holds the response body struct for the package forgetfollower

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/ccr/forget_follower/ForgetFollowerIndexResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response