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(ctx context.Context) (*http.Response, error)
  • func (r *ForgetFollower) Header(key, value string) *ForgetFollower
  • func (r *ForgetFollower) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ForgetFollower) Index(v string) *ForgetFollower
  • func (r *ForgetFollower) Raw(raw json.RawMessage) *ForgetFollower
  • func (r *ForgetFollower) Request(req *Request) *ForgetFollower
• type NewForgetFollower
  • func NewForgetFollowerFunc(tp elastictransport.Interface) NewForgetFollower
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FollowerCluster(followercluster string) *RequestBuilder
  • func (rb *RequestBuilder) FollowerIndex(followerindex types.IndexName) *RequestBuilder
  • func (rb *RequestBuilder) FollowerIndexUuid(followerindexuuid types.Uuid) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) LeaderRemoteCluster(leaderremotecluster string) *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 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/{branch}/ccr-post-forget-follower.html

func (ForgetFollower) Do

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

Do runs the http.Request through the provided transport.

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

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

Index the name of the leader index for which specified follower retention leases should be removed API Name: index

func (*ForgetFollower) Raw

func (r *ForgetFollower) Raw(raw json.RawMessage) *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 *types.IndexName `json:"follower_index,omitempty"`

	FollowerIndexUuid *types.Uuid `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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ccr/forget_follower/ForgetFollowerIndexRequest.ts#L23-L39

type RequestBuilder

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

RequestBuilder is the builder API for the forgetfollower.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) FollowerCluster

func (rb *RequestBuilder) FollowerCluster(followercluster string) *RequestBuilder

func (*RequestBuilder) FollowerIndex

func (rb *RequestBuilder) FollowerIndex(followerindex types.IndexName) *RequestBuilder

func (*RequestBuilder) FollowerIndexUuid

func (rb *RequestBuilder) FollowerIndexUuid(followerindexuuid types.Uuid) *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) LeaderRemoteCluster

func (rb *RequestBuilder) LeaderRemoteCluster(leaderremotecluster string) *RequestBuilder