resumefollow

Documentation

Overview

Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index.

Index

• Variables
• type NewResumeFollow
  • func NewResumeFollowFunc(tp elastictransport.Interface) NewResumeFollow
• 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
• type ResumeFollow
  • func New(tp elastictransport.Interface) *ResumeFollow
  • func (r ResumeFollow) Do(providedCtx context.Context) (*Response, error)
  • func (r *ResumeFollow) ErrorTrace(errortrace bool) *ResumeFollow
  • func (r *ResumeFollow) FilterPath(filterpaths ...string) *ResumeFollow
  • func (r *ResumeFollow) Header(key, value string) *ResumeFollow
  • func (r *ResumeFollow) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ResumeFollow) Human(human bool) *ResumeFollow
  • func (r *ResumeFollow) MaxOutstandingReadRequests(maxoutstandingreadrequests int64) *ResumeFollow
  • func (r *ResumeFollow) MaxOutstandingWriteRequests(maxoutstandingwriterequests int64) *ResumeFollow
  • func (r *ResumeFollow) MaxReadRequestOperationCount(maxreadrequestoperationcount int64) *ResumeFollow
  • func (r *ResumeFollow) MaxReadRequestSize(maxreadrequestsize string) *ResumeFollow
  • func (r *ResumeFollow) MaxRetryDelay(duration types.Duration) *ResumeFollow
  • func (r *ResumeFollow) MaxWriteBufferCount(maxwritebuffercount int64) *ResumeFollow
  • func (r *ResumeFollow) MaxWriteBufferSize(maxwritebuffersize string) *ResumeFollow
  • func (r *ResumeFollow) MaxWriteRequestOperationCount(maxwriterequestoperationcount int64) *ResumeFollow
  • func (r *ResumeFollow) MaxWriteRequestSize(maxwriterequestsize string) *ResumeFollow
  • func (r ResumeFollow) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ResumeFollow) Pretty(pretty bool) *ResumeFollow
  • func (r *ResumeFollow) Raw(raw io.Reader) *ResumeFollow
  • func (r *ResumeFollow) ReadPollTimeout(duration types.Duration) *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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ccr/resume_follow/ResumeFollowIndexRequest.ts#L25-L52

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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package resumefollow

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/ccr/resume_follow/ResumeFollowIndexResponse.ts#L22-L24

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

Resume a follower. Resume a cross-cluster replication follower index that was paused. The follower index could have been paused with the pause follower API. Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. When this API returns, the follower index will resume fetching operations from the leader index.

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

func (ResumeFollow) Do

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

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

func (*ResumeFollow) ErrorTrace

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

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

func (*ResumeFollow) FilterPath

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

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

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

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

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 (*ResumeFollow) MaxOutstandingReadRequests

func (r *ResumeFollow) MaxOutstandingReadRequests(maxoutstandingreadrequests int64) *ResumeFollow

API name: max_outstanding_read_requests

func (*ResumeFollow) MaxOutstandingWriteRequests

func (r *ResumeFollow) MaxOutstandingWriteRequests(maxoutstandingwriterequests int64) *ResumeFollow

API name: max_outstanding_write_requests

func (*ResumeFollow) MaxReadRequestOperationCount

func (r *ResumeFollow) MaxReadRequestOperationCount(maxreadrequestoperationcount int64) *ResumeFollow

API name: max_read_request_operation_count

func (*ResumeFollow) MaxReadRequestSize

func (r *ResumeFollow) MaxReadRequestSize(maxreadrequestsize string) *ResumeFollow

API name: max_read_request_size

func (*ResumeFollow) MaxRetryDelay

func (r *ResumeFollow) MaxRetryDelay(duration types.Duration) *ResumeFollow

API name: max_retry_delay

func (*ResumeFollow) MaxWriteBufferCount

func (r *ResumeFollow) MaxWriteBufferCount(maxwritebuffercount int64) *ResumeFollow

API name: max_write_buffer_count

func (*ResumeFollow) MaxWriteBufferSize

func (r *ResumeFollow) MaxWriteBufferSize(maxwritebuffersize string) *ResumeFollow

API name: max_write_buffer_size

func (*ResumeFollow) MaxWriteRequestOperationCount

func (r *ResumeFollow) MaxWriteRequestOperationCount(maxwriterequestoperationcount int64) *ResumeFollow

API name: max_write_request_operation_count

func (*ResumeFollow) MaxWriteRequestSize

func (r *ResumeFollow) MaxWriteRequestSize(maxwriterequestsize string) *ResumeFollow

API name: max_write_request_size

func (ResumeFollow) Perform

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

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

func (*ResumeFollow) Pretty

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

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

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

func (r *ResumeFollow) ReadPollTimeout(duration types.Duration) *ResumeFollow

API name: read_poll_timeout

func (*ResumeFollow) Request

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

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