unfollow

package
v8.4.0 Latest Latest
Warning

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

Go to latest
Published: Aug 24, 2022 License: Apache-2.0 Imports: 10 Imported by: 3

Documentation

Overview

Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

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 NewUnfollow

type NewUnfollow func(index string) *Unfollow

NewUnfollow type alias for index.

func NewUnfollowFunc

func NewUnfollowFunc(tp elastictransport.Interface) NewUnfollow

NewUnfollowFunc returns a new instance of Unfollow with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Unfollow

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

func New

Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ccr-post-unfollow.html

func (Unfollow) Do

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

Do runs the http.Request through the provided transport.

func (*Unfollow) Header

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

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

func (*Unfollow) HttpRequest

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

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

func (*Unfollow) Index

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

Index The name of the follower index that should be turned into a regular index. API Name: index

func (Unfollow) IsSuccess

func (r Unfollow) 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.

Jump to

Keyboard shortcuts

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