forgetfollower

package
v8.11.1 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

Removes the follower retention leases from the leader.

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 ForgetFollower

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

func (ForgetFollower) Do

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

func (*ForgetFollower) FollowerCluster added in v8.9.0

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

API name: follower_cluster

func (*ForgetFollower) FollowerIndex added in v8.9.0

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

API name: follower_index

func (*ForgetFollower) FollowerIndexUuid added in v8.9.0

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) LeaderRemoteCluster added in v8.9.0

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

API name: leader_remote_cluster

func (ForgetFollower) Perform added in v8.7.0

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

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

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/5fea44e006349579bf3561a82e997002e5716117/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L38

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

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

FromJSON allows to load an arbitrary json into the request structure

type Response added in v8.7.0

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/5fea44e006349579bf3561a82e997002e5716117/specification/ccr/forget_follower/ForgetFollowerIndexResponse.ts#L22-L24

func NewResponse added in v8.7.0

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