resumefollow

Documentation

Overview

Resumes a follower index that has been paused

Index

• Variables
• type NewResumeFollow
  • func NewResumeFollowFunc(tp elastictransport.Interface) NewResumeFollow
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type ResumeFollow
  • func New(tp elastictransport.Interface) *ResumeFollow
  • func (r ResumeFollow) Do(ctx context.Context) (*Response, error)
  • func (r *ResumeFollow) Header(key, value string) *ResumeFollow
  • func (r *ResumeFollow) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ResumeFollow) Index(v string) *ResumeFollow
  • func (r ResumeFollow) Perform(ctx context.Context) (*http.Response, error)
  • func (r *ResumeFollow) Raw(raw io.Reader) *ResumeFollow
  • func (r *ResumeFollow) Request(req *Request) *ResumeFollow

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 NewResumeFollow

type NewResumeFollow func(index string) *ResumeFollow

NewResumeFollow type alias for index.

func NewResumeFollowFunc

func NewResumeFollowFunc(tp elastictransport.Interface) NewResumeFollow

NewResumeFollowFunc returns a new instance of ResumeFollow 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 {
	MaxOutstandingReadRequests    *int64         `json:"max_outstanding_read_requests,omitempty"`
	MaxOutstandingWriteRequests   *int64         `json:"max_outstanding_write_requests,omitempty"`
	MaxReadRequestOperationCount  *int64         `json:"max_read_request_operation_count,omitempty"`
	MaxReadRequestSize            *string        `json:"max_read_request_size,omitempty"`
	MaxRetryDelay                 types.Duration `json:"max_retry_delay,omitempty"`
	MaxWriteBufferCount           *int64         `json:"max_write_buffer_count,omitempty"`
	MaxWriteBufferSize            *string        `json:"max_write_buffer_size,omitempty"`
	MaxWriteRequestOperationCount *int64         `json:"max_write_request_operation_count,omitempty"`
	MaxWriteRequestSize           *string        `json:"max_write_request_size,omitempty"`
	ReadPollTimeout               types.Duration `json:"read_poll_timeout,omitempty"`
}

Request holds the request body struct for the package resumefollow

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L47

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

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

type ResumeFollow

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

func New

func New(tp elastictransport.Interface) *ResumeFollow

Resumes a follower index that has been paused

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

func (ResumeFollow) Do

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

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

func (*ResumeFollow) Header

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

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

func (*ResumeFollow) HttpRequest

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

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

func (*ResumeFollow) Index

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

Index The name of the follow index to resume following. API Name: index

func (ResumeFollow) Perform

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

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

func (*ResumeFollow) Raw

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

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

func (*ResumeFollow) Request

func (r *ResumeFollow) Request(req *Request) *ResumeFollow

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